文档

GetVMDeployOrder - 获取部署单详情

更新时间:

可以获取部署单详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /organization/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
pipelineIdlong

流水线 ID,可在流水线链接中获取,如 https://flow.aliyun.com/pipelines/【PipelineId】/current

1222
deployOrderIdlong

部署单 ID

11111

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMessagestring

错误信息

”“
successboolean

true 接口调用成功,false 接口调用失败

true 接口调用成功,false 接口调用失败
errorCodestring

错误码

”“
deployOrderobject

部署单

deployOrderIdstring

部署单 ID

11111
createTimelong

创建时时间

111111111111
updateTimelong

修改时间

11111111111
creatorstring

创建人

ssaassa
currentBatchinteger

当前发布批次

2
totalBatchinteger

总发布批次

3
statusstring

发布状态

  • Waiting(暂停)

  • Running(部署中)

  • Cancelled(已取消)

  • Success(成功)

Success
exceptionCodestring

错误码

错误信息
deployMachineInfoobject

部署机器信息

hostGroupIdlong

主机组 ID

1111
batchNuminteger

发布批次

11
deployMachinesobject []

部署机器列表

createTimelong

开始时间

1111111111
updateTimelong

修改时间

11111111
statusstring
  • Success(成功)

  • Pending(待部署)

  • Running(部署中)

  • Cancelled(取消)

  • Queued(部署等待中)

  • Failed(失败)

  • Skipped(已跳过)

Success
machineSnstring

机器 sn

sasssasa
clientStatusstring

ok(正常) error(连接失败)

ok
ipstring

机器 IP

127.0.0.1
actionsobject []

后续 action

typestring
  • RetryVMDeployMachine 重试机器部署
  • SkipVMDeployMachine 跳过机器部署
  • LogVMDeployMachine 查看机器部署日志
RetryVMDeployMachine
disableboolean

当前用户是否有权限进行后续 action

true
paramsobject

参数

{}
batchNuminteger

部署批次

22
actionsobject []

后续 action

typestring

StopVMDeployOrder 取消部署单 ResumeVMDeployOrder 继续部署单运行

StopVMDeployOrder
disableboolean

当前用户是否有权限进行后续 action

true
paramsobject

参数

{}

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMessage": "”“",
  "success": true,
  "errorCode": "”“",
  "deployOrder": {
    "deployOrderId": "11111",
    "createTime": 111111111111,
    "updateTime": 11111111111,
    "creator": "ssaassa",
    "currentBatch": 2,
    "totalBatch": 3,
    "status": "Success",
    "exceptionCode": "错误信息",
    "deployMachineInfo": {
      "hostGroupId": 1111,
      "batchNum": 11,
      "deployMachines": [
        {
          "createTime": 1111111111,
          "updateTime": 11111111,
          "status": "Success",
          "machineSn": "sasssasa",
          "clientStatus": "ok",
          "ip": "127.0.0.1",
          "actions": [
            {
              "type": "RetryVMDeployMachine",
              "disable": true,
              "params": {}
            }
          ],
          "batchNum": 22
        }
      ]
    },
    "actions": [
      {
        "type": "StopVMDeployOrder",
        "disable": true,
        "params": {}
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidCluster.NotFoundNo cluster is available to generate the workspace.没有可用的集群,无法创建工作空间
400InvalidCodeUrl.NotSupportSVNThe parameter codeUrl is invalid. SVN is not supported.参数错误,不支持svn
400InvalidParam.ParamNotPresentThe parameter is invalid.参数有误,请检查参数
400InvalidResource.NotFoundNo resource is found. You cannot create the workspace. Please try again later.没有资源,无法创建工作空间,请稍后尝试
400InvalidResourceRole.NotFounThe member role is invalid.无效的成员角色,请检查参数
400InvalidResourceRole.NotFoundThe member role is invalid.无效的成员角色,请检查参数
400InvalidUser.NotFoundThe user that is invoking the API service is not a registered user.调用 API 的用户,未注册为云效用户
400InvalidUser.ResourceMemberCouldNotDeleteOwnerResource owner cannot be deleted.无法删除资源owner
400InvalidUser.ResourceMemberNotExistsThe resource member does not exist.该资源成员不存在,请检查参数
400InvalidUser.UserNotInCurrentOrganizationThe user is not in the organization.当前用户不在该企业中
400InvalidWorkspaceStatus.NotSuccessThe workspace status is invalid. You can only operate workspaces with the SUCCESS status.工作空间状态非法,只能操作状态是SUCCESS的工作空间
400InvalidWorkspaceTemplate.NotFoundThe parameter workspaceTemplate is not found.技术栈(即空间模板)不存在
403Forbidden.AccessDeniedThe user is not authorized to perform the operation.用户无权限执行相关操作
403Forbidden.UserNotAdminOrOwnerThe current user is not an admin or owner in the organization and is not authorized to perform the operation.当前用户非该企业管理员或拥有者,无权进行操作。
403Forbidden.UserNotInCurrentOrganizationThe user is not in the organization and is not authorized to perform the operation.当前用户不在该企业中,无权进行操作。
404InvalidOrganization.NotFoundThe organization is not found.企业不存在,请检查企业ID是否正确
404InvalidPipeline.NotFoundThe pipeline is not found.流水线不存在
404InvalidPipelineRun.NotFoundThe pipeline execution instance is not found.流水线运行实例不存在
404InvalidUser.UserNotInCurrentOrganizationThe current user is not in the organization and has no permission to operate.当前用户不在该企业中,无权进行操作。
404InvalidWorkspace.NotFoundThe workspace is not found.工作空间不存在

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)