可以获取流水线信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /organization/{organizationId}/pipelines/{pipelineId}
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
organizationId | string | 是 | 企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 | 5ebbc0228123212b59xxxxx |
pipelineId | long | 是 | 流水线 ID,可在流水线链接中获取,如 https://flow.aliyun.com/pipelines/【PipelineId】/current | 234 |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"errorMessage": "\"\"",
"pipeline": {
"creatorAccountId": "112222122",
"envId": 0,
"envName": "日常环境",
"createTime": 1586863220000,
"updateTime": 1586863220000,
"groupId": 1111,
"modifierAccountId": "112222122",
"name": "流水线",
"tagList": [
{
"id": 22,
"name": "标签1"
}
],
"pipelineConfig": {
"flow": "schema: tb pipeline: - name: 执行命令 stages: - driven: AUTO jobs: - displayName: 执行命令 task: execution-component-production@10 identifier: '10_1626147407245' templateType: task templateSign: '' templateBatchUpdate: 'N' extraInfo: '' params: version1: pre-jdk1.62 steps: - name: 执行命令 stepType: exec-shell stepIdentifier: '10_1626147407245__11_1626147407249' command: | # input your command here echo hello,world! ARTIFACTS: '' JSONEncoding: true freeInTaskGroupModeFields: - ARTIFACTS source: 132504-sss_ddd_3mvJ ENGINE_PIPELINE_NAME: '${INPUTS.ENGINE_PIPELINE_NAME}' ENGINE_PIPELINE_ID: '${INPUTS.ENGINE_PIPELINE_ID}' ENGINE_PIPELINE_INST_ID: '${INPUTS.ENGINE_PIPELINE_INST_ID}' ENGINE_PIPELINE_INST_NUMBER: '${INPUTS.ENGINE_PIPELINE_INST_NUMBER}' buildNodeGroup: K8S-4 plugins: [] output: [] freeInTaskGroupModeFields: []",
"settings": "{}",
"sources": [
{
"sign": "xxsxsxs",
"type": "Codeup",
"data": {
"branch": "master",
"serviceConnectionId": 12,
"label": "cdup/ss",
"isTrigger": true,
"repo": "https://codeup.aliyun.com/test.git",
"triggerFilter": ".*",
"webhook": "https://flow.aliyun/webhook/asassasa",
"events": [
"push"
],
"isBranchMode": false,
"isSubmodule": false,
"isCloneDepth": true,
"cloneDepth": 1,
"credentialId": 222,
"credentialType": "region-ssh",
"credentialLabel": "企业公钥",
"namespace": "asasasas"
}
}
]
}
},
"success": true,
"errorCode": "\"\""
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParam.ParamNotPresent | The parameter is invalid. | 参数有误,请检查参数 |
400 | InvalidUser.NotFound | The user that is invoking the API service is not a registered user. | 调用 API 的用户,未注册为云效用户 |
403 | Forbidden.UserNotInCurrentOrganization | The user is not in the organization and is not authorized to perform the operation. | 当前用户不在该企业中,无权进行操作。 |
404 | InvalidOrganization.NotFound | The organization is not found. | 企业不存在,请检查企业ID是否正确 |
404 | InvalidPipeline.NotFound | The pipeline is not found. | 流水线不存在 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史