更新时间:2024-11-07 GMT+08:00

查看专享版实例创建进度

功能介绍

查看专享版实例创建进度

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/progress

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID,在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

progress

Integer

实例创建进度

单位:百分比

status

String

实例创建状态

  • creating:创建中

  • success:创建成功

  • failed:创建失败

error_code

String

实例创建失败错误码

error_msg

String

实例创建失败错误信息

start_time

Long

实例创建开始时间。unix时间戳格式。

end_time

Long

实例创建结束时间。unix时间戳格式。

状态码: 401

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码: 200

OK

  • 实例创建成功

    {
      "end_time" : 1597390224911,
      "error_code" : null,
      "error_msg" : null,
      "progress" : 100,
      "start_time" : 1597389901161,
      "status" : "success"
    }
  • 实例创建中

    {
      "end_time" : 1597390224911,
      "error_code" : null,
      "error_msg" : null,
      "progress" : 50,
      "start_time" : 1597389901161,
      "status" : "creating"
    }
  • 实例创建失败(配额不足)

    {
      "end_time" : 1597390224911,
      "error_code" : "APIC.9218",
      "error_msg" : "create failed...",
      "progress" : 0,
      "start_time" : 1597389901161,
      "status" : "failed"
    }
  • 实例创建失败(资源不足)

    {
      "end_time" : 1597390224911,
      "error_code" : "APIC.9219",
      "error_msg" : "create failed...",
      "progress" : 0,
      "start_time" : 1597389901161,
      "status" : "failed"
    }
  • 实例创建失败(其他原因)

    {
      "end_time" : 1597390224911,
      "error_code" : "APIC.9206",
      "error_msg" : "create failed...",
      "progress" : 0,
      "start_time" : 1597389901161,
      "status" : "failed"
    }

状态码: 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

状态码: 404

Not Found

{
  "error_code" : "APIC.7302",
  "error_msg" : "Instance not found"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码