查看专享版实例详情
功能介绍
查看专享版实例详情
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 枚举值：
|
|
description |
String |
实例描述 |
|
vpc_id |
String |
虚拟私有云ID。 获取方法如下：
|
|
subnet_id |
String |
子网的网络ID。 获取方法如下：
|
|
security_group_id |
String |
指定实例所属的安全组。 获取方法如下：
|
|
maintain_begin |
String |
'维护时间窗开始时间。时间格式为 xx:00:00，xx取值为02,06,10,14,18,22。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次。' |
|
maintain_end |
String |
'维护时间窗结束时间。时间格式为 xx:00:00，与维护时间窗开始时间相差4个小时。' '在这个时间段内，运维人员可以对该实例的节点进行维护操作。维护期间，业务可以正常使用，可能会发生闪断。维护操作通常几个月一次'。 |
|
ingress_ip |
String |
实例入口，虚拟私有云访问地址 |
|
user_id |
String |
实例所属用户ID |
|
nat_eip_address |
String |
实例出公网IP |
|
bandwidth_size |
Integer |
出公网带宽 |
|
bandwidth_charging_mode |
String |
出公网带宽计费模式 |
|
available_zone_ids |
String |
可用区 |
|
instance_version |
String |
实例版本编号 |
|
virsubnet_id |
String |
子网的网络ID。 暂不支持 |
|
roma_eip_address |
String |
roma弹性公网IP。 暂不支持 |
|
listeners |
Object |
监听信息 暂不支持 |
|
supported_features |
Array of strings |
实例支持的特性列表 |
|
endpoint_service |
EndpointService object |
终端节点服务详情 待废弃，优先使用endpoint_services |
|
endpoint_services |
Array of EndpointService objects |
终端节点服务列表 |
|
node_ips |
NodeIps object |
服务节点IP |
|
publicips |
Array of IpDetails objects |
公网入口地址列表 |
|
privateips |
Array of IpDetails objects |
私网入口地址列表 |
|
unreliable_ips |
Array of strings |
不建议使用的实例入口列表：分组子域名解析未指向到该列表的IP，不能用该列表的IP直接访问DEFAULT分组 |
|
is_releasable |
Boolean |
实例是否可释放
|
|
ingress_bandwidth_charging_mode |
String |
入公网带宽计费模式 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
livedata |
Array of strings |
livedata节点IP地址列表 |
|
shubao |
Array of strings |
shubao节点IP地址列表 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码： 200
OK
{
"id" : "8dfxxxxxxxxxxxxxxxxxxxxxxxxxx00p",
"spec" : "BASIC",
"project_id" : "78xxxxxxxxxxxxxxxxxxxxxxxxxxxxoi",
"instance_name" : "apig-demo",
"status" : "Running",
"instance_status" : 6,
"eip_address" : null,
"type" : null,
"create_time" : 1635890506328,
"charging_mode" : 0,
"enterprise_project_id" : "0",
"loadbalancer_provider" : "elb",
"description" : "test create instance",
"instance_version" : "acc6d368a3cb4d47840380bf62b0ab32",
"available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]",
"user_id" : "e966ff7227ef4df49df7d57aaf00f8ed",
"vpc_id" : "0402ea19-5457-4032-9d1b-eb48b98f6c66",
"subnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
"virsubnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
"security_group_id" : "4b95a790-5cfc-463d-8de5-42199e55371c",
"maintain_begin" : "22:00:00",
"maintain_end" : "02:00:00",
"ingress_ip" : "192.168.0.152",
"ingress_ip_v6" : null,
"nat_eip_address" : "xxx.xxx.xxx.xxx",
"roma_eip_address" : null,
"bandwidth_size" : 5,
"bandwidth_charging_mode" : "traffic",
"supported_features" : [ "lts", "gateway_responses", "ratelimit", "request_body_size", "backend_timeout", "app_token", "app_basic", "app_secret", "multi_auth", "route", "sign_basic", "app_route", "backend_client_certificate", "ssl_ciphers", "cors", "app_quota", "app_acl", "real_ip_from_xff", "set_resp_headers", "vpc_backup", "throttle_strategy", "watch_instance", "sign_aes", "mock_status_code_and_header", "backend_retry_count", "custom_log", "real_ip_header_getter", "policy_sys_param", "vpc_name_modifiable", "breaker", "default_group_host_trustlist" ],
"node_ips" : {
"livedata" : [ ],
"shubao" : [ "192.168.0.123", "192.168.0.114" ]
},
"endpoint_service" : null,
"endpoint_services" : [ {
"service_name" : "xx-xxx-7a.apig.20bc4a91-1542-43s2-a278-b1e49c0hh6f9",
"created_at" : "2021-8-03 06:04:43"
} ],
"publicips" : [ {
"ip_address" : "xxx.xxx.xxx.xxx",
"bandwidth_size" : 5
} ],
"privateips" : [ {
"ip_address" : "xxx.xxx.xxx.xxx",
"bandwidth_size" : 5
} ],
"ingress_bandwidth_charging_mode" : "traffic",
"cbc_operation_locks" : [ {
"lock_scene" : "TO_PERIOD_LOCK",
"lock_source_id" : "CxxxxxxxxxxxM"
} ],
"unreliable_ips" : [ "192.xx.xxx.xxx" ]
}
状态码： 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 |
错误码
请参见错误码。
