- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- APIG业务使用流程
- 创建用户并授权使用APIG
- 创建APIG实例
- 开放API
- 配置API调用授权(可选)
- 调用API
-
管理API
- 管理API概述
- 查看或编辑APIG的API信息
- 配置API的自定义认证
- 配置API的参数编排规则
- 自定义API的错误响应信息
- 克隆APIG的API
- 下线APIG的API
- 导入导出API
-
APIG的API设计文件扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- x-apigateway-auth-opt
- x-apigateway-result-normal-sample
- x-apigateway-result-failure-sample
- x-apigateway-authorizer
- x-apigateway-response
- x-apigateway-responses
- x-apigateway-pass-through
- x-apigateway-sample
- x-apigateway-content-type
- x-apigateway-orchestrations
- 配置API策略
- 配置凭据策略
- 管理APIG实例
- 查看监控指标与配置告警
- 查看APIG审计日志
- 共享版操作指导(仅存量用户使用)
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 专享版-编排规则管理
- 专享版-实例自定义入方向端口管理
- 共享版API(仅存量用户使用)
- 专享版API(V1)(待下线)
- 权限策略和授权项
- 附录
- 修订记录
- SDK参考
- 场景代码示例
-
常见问题
- 热门咨询
- 产品咨询
- 开放API
- 发布API
-
调用API
- 调用API失败的可能原因
- 调用API报“414 Request URI too large”
- 调用API报“The API does not exist or has not been published in the environment”
- 调用API报“No backend available”
- API的后端服务报“Backend unavailable”或“Backend timeout”
- API的后端服务报“Backend domain name resolution failed”
- 调用API报“Incorrect IAM authentication information”
- 调用API报“Incorrect app authentication information”
- 修改API后端服务的超时时间上限“backend_timeout”后未生效
- APIG对API请求体的大小是否有限制?
- API调用对请求的响应消息体限制
- 使用iOS系统时,如何使用APP认证调用API?
- 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- APIG是否支持WebSocket数据传输?
- API的策略后端有多个时,怎么匹配和执行API请求?
- 如何通过APIG访问公网后端服务?
- API认证
- API策略
- 导入导出API
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询专享版实例列表
功能介绍
查询专享版实例列表
调用方法
请参见如何调用API。
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 |
错误码
请参见错误码。