查询专享版实例列表 - ListInstancesV2
功能介绍
查询专享版实例列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
apig:instance:list
List
-
-
- apig:instances:list
-
URI
GET /v2/{project_id}/apigw/instances
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方式请参见获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | Long | 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
limit | 否 | Integer | 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
instance_id | 否 | String | 实例编号 |
instance_name | 否 | String | 实例名称 |
status | 否 | String | 实例状态：
|
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
size | Integer | 本次返回的列表长度 |
total | Long | 满足条件的记录数 |
instances | Array of RespInstanceBase objects | 实例列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 实例ID |
project_id | String | 实例所属租户ID |
instance_name | String | 实例名称 |
status | String | 实例状态：
|
instance_status | Integer | 实例状态对应编号
|
type | String | 实例类型 默认apig |
spec | String | 实例规格：
|
create_time | Long | 实例创建时间。unix时间戳格式。 |
enterprise_project_id | String | 企业项目ID，企业账号必填 |
eip_address | String | 实例绑定的弹性IP地址 |
charging_mode | Integer | 实例计费方式：
|
cbc_metadata | String | 包周期计费订单编号 |
loadbalancer_provider | String | 实例使用的负载均衡器类型
缺省值：lvs |
cbc_operation_locks | Array of CbcOperationLock objects | 云运营限制操作锁 |
参数 | 参数类型 | 描述 |
|---|---|---|
lock_scene | String | 限制操作场景：
|
lock_source_id | String | 发起限制操作对象的标志 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
无
响应示例
状态码：200
OK
{
"total" : 2,
"size" : 2,
"instances" : [ {
"cbc_metadata" : "CS2006301043A28NF:00301-734023-0--0",
"charging_mode" : 1,
"create_time" : 1585302825070,
"eip_address" : "xxx.xxx.xxx.xxx",
"enterprise_project_id" : "0",
"id" : "eddc4d25480b4cd6b512f270a1b8b341",
"instance_name" : "apig-Enterprise_Project_Pay-per-Use",
"instance_status" : 6,
"project_id" : "73d69ae0cfcf460190522d06b60f05ad",
"spec" : "PROFESSIONAL",
"status" : "Running",
"type" : "apig"
}, {
"charging_mode" : 0,
"create_time" : 1594370987422,
"eip_address" : "xxx.xxx.xxx.xxx",
"enterprise_project_id" : "0",
"id" : "2e2d613c64094a4a94ad38e7ca30adee",
"instance_name" : "apig-autotest-apitest-nodelete",
"instance_status" : 6,
"project_id" : "73d69ae0cfcf460190522d06b60f05ad",
"spec" : "PROFESSIONAL",
"status" : "Running",
"type" : "apig",
"cbc_operation_locks" : [ {
"lock_scene" : "TO_PERIOD_LOCK",
"lock_source_id" : "CxxxxxxxxxxxM"
} ]
} ]
} 状态码：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"
} 状态码：500
Internal Server Error
{
"error_code" : "APIC.9000",
"error_msg" : "Failed to request internal service"
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
500 | Internal Server Error |
错误码
请参见错误码。
