Terminal
Terminal/Skill
Diagnoses failed Yunxiao Flow pipeline runs, covering build, test, and deploy steps, and suggests fixes from step logs.
By Alibaba Cloud
Works with
npx skills add aliyun/alibabacloud-aiops-skills --skill alibabacloud-yunxiao-flow-analysisThis skill provides comprehensive troubleshooting and analysis capabilities for Yunxiao Flow pipeline failures. It helps diagnose issues across various pipeline stages, including:
Covered Pipeline Types:
Architecture: Python Scripts → Yunxiao Flow API → Pipeline Execution Logs → Failure Analysis → Solution Recommendations.
The websocket-client library is required.
| Environment Variable | Description | Required |
|---|---|---|
| YUNXIAO_ACCESS_TOKEN | Yunxiao Personal Access Token (format: pt-xxx) | Yes |
Before executing any commands, ensure you have a valid Yunxiao Personal Access Token configured via environment variable.
export YUNXIAO_ACCESS_TOKEN="pt-xxxxxxxxxxxxx"
Security Design:
YUNXIAO_ACCESS_TOKEN — CLI arguments are not supported to prevent exposure in process listings (ps/top), shell history, and /proc/*/cmdlinept- prefix) before any network transmission to prevent accidental credential leakageSecurity Rules:
This skill uses token-based authentication for Yunxiao Flow API. Required permissions:
For detailed permission requirements and failure handling, see references/ram-policies.md.
[MUST] Permission Failure Handling: When any command or API call fails due to permission errors at any point during execution, follow this process:
- Read
references/ram-policies.mdto get the full list of permissions required by this SKILL- Verify that the Yunxiao Personal Access Token has the necessary permissions
- Pause and wait until the user confirms that the required permissions have been granted
Important: Parameter Confirmation — Before executing any command or API call, all customizable parameters must be confirmed with the user. Never assume or use default values without explicit user approval.
| Parameter | Required/Optional | Description | Default |
|---|---|---|---|
| org-id | Required | Organization ID (24 characters for central org, 32 characters for regional org) | None |
| pipeline-id | Required | Pipeline ID | None |
| pipeline-runid | Required | Pipeline Run ID | None |
| YUNXIAO_ACCESS_TOKEN | Required (environment variable) | Personal Access Token (format: pt-xxx), set via export YUNXIAO_ACCESS_TOKEN="pt-xxx" | None |
| domain | Optional | API domain (default: openapi-rdc.aliyuncs.com) | openapi-rdc.aliyuncs.com |
Note: All scripts read the token from environment variable
YUNXIAO_ACCESS_TOKEN. Ensure it is set before running any command.
python3 scripts/yunxiao_flow_get_pipeline_runs.py \
--org-id <org-id> --pipeline-id <pipeline-id> \
--pipeline-runid <pipeline-runid> --domain <domain>
Analyze the returned JSON:
status field (SUCCESS/FAIL/RUNNING/INIT)stages to find the failed stagepython3 scripts/yunxiao_flow_get_job_step_log.py \
--org-id <org-id> --pipeline-id <pipeline-id> --pipeline-runid <pipeline-runid> \
--job-id <job-id> --step-index <step-index> --build-id <build-id> \
--domain <domain> --full-log
python3 scripts/yunxiao_flow_get_vm_deploy_machine_log.py \
--org-id <org-id> --pipeline-id <pipeline-id> --pipeline-runid <pipeline-runid> \
--deploy-order-id <deploy-order-id> --machine-sn <machine-sn> \
--domain <domain>
Read the corresponding reference documents based on the failure scenario. For detailed guidance, see references/troubleshooting-guide.md.
Must read: yunxiao_base.md, yunxiao_flow_get_pipeline_runs.md
After confirming the build cluster and code clone information, output:
params.buildNodeGroup. It MUST be obtained from the "Request Runtime Environment" step logs.), build environment, trigger time, status, failed job, failed step, downloaded code source, job workspace (can be viewed from the PROJECT_DIR in the Pipeline Cache step)For verification steps, see references/verification-method.md
No resource cleanup required. This skill only performs read operations for analysis purposes.
params.buildNodeGroupyunxiao_base.md and yunxiao_flow_get_pipeline_runs.md before scenario-specific files[Build Cluster Info] >> Cluster Name : Yunxiao China Hong Kong Build Cluster[Build Cluster Info] >> Cluster Name : Hangzhou VPC Build Cluster[Runner Group Info]: >> RunnerGroupName : xxxxx| Reference Document | Description |
|---|---|
| troubleshooting-guide.md | Complete troubleshooting guide (org types, knowledge base selection, build cluster identification) |
| yunxiao_base.md | Yunxiao fundamentals (org types, API versions, PAT, pipeline concepts) |
| yunxiao_flow_get_pipeline_runs.md | Pipeline runs API field documentation |
| flow_git_clone.md | Code clone error troubleshooting |
| flow_build_docker.md | Docker image build troubleshooting |
| flow_build_nodeJs.md | Node.js build troubleshooting |
| flow_build_python.md | Python build troubleshooting |
| flow_customEnvironmentBuild.md | Custom environment build error troubleshooting |
| flow_build_java.md | Java build troubleshooting |
| flow_deploy_docker.md | Docker deployment troubleshooting |
| flow_deploy_kubectl.md | Kubernetes deployment troubleshooting |
| flow_deploy_vm.md | VM deployment troubleshooting |
| flow_deploy_fc.md | Function Compute deployment troubleshooting |
| flow_test_python.md | Python unit test troubleshooting |
| flow_test_maven.md | Maven/Java unit test troubleshooting |
| flow_test_nodeJS.md | Node.js unit test troubleshooting |
| flow_test_golang.md | Golang unit test troubleshooting |
| flow_test_php.md | PHP unit test troubleshooting |
| flow_variables.md | Pipeline variable configuration |
| flow_workspace_runtime.md | Workspace and runtime environment troubleshooting |
| ram-policies.md | RAM permission requirements and authentication guide |
| related-commands.md | Complete list of all script commands |
| Script | Function |
|---|---|
yunxiao_flow_get_pipeline_runs.py | Get pipeline run information |
yunxiao_flow_get_job_step_log.py | Get step execution logs |
yunxiao_flow_get_vm_deploy_order.py | Get VM deployment order details |
yunxiao_flow_get_vm_deploy_machine_log.py | Get VM deployment machine logs |
webTerminal.py | Connect to container environment debug terminal |