计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查看专享版实例详情

功能介绍

查看专享版实例详情

调用方法

请参见如何调用API

URI

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

表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参数

参数

参数类型

描述

id

String

实例ID

project_id

String

实例所属租户ID

instance_name

String

实例名称

status

String

实例状态:

  • Creating:创建中
  • CreateSuccess:创建成功
  • CreateFail:创建失败
  • Initing:初始化中
  • Registering:注册中
  • Running:运行中
  • InitingFailed:初始化失败
  • RegisterFailed:注册失败
  • Installing:安装中
  • InstallFailed:安装失败
  • Updating:升级中
  • UpdateFailed:升级失败
  • Rollbacking:回滚中
  • RollbackSuccess:回滚成功
  • RollbackFailed:回滚失败
  • Deleting:删除中
  • DeleteFailed:删除失败
  • Unregistering:注销中
  • UnRegisterFailed:注销失败
  • CreateTimeout:创建超时
  • InitTimeout:初始化超时
  • RegisterTimeout:注册超时
  • InstallTimeout:安装超时
  • UpdateTimeout:升级超时
  • RollbackTimeout:回滚超时
  • DeleteTimeout:删除超时
  • UnregisterTimeout:注销超时
  • Starting:启动中
  • Freezing:冻结中
  • Frozen:已冻结
  • Restarting:重启中
  • RestartFail:重启失败
  • Unhealthy:实例异常
  • RestartTimeout:重启超时
  • Resizing:规格变更中
  • ResizeFailed:规格变更失败
  • ResizeTimeout:规格变更超时

枚举值:

  • Creating
  • CreateSuccess
  • CreateFail
  • Initing
  • Registering
  • Running
  • InitingFailed
  • RegisterFailed
  • Installing
  • InstallFailed
  • Updating
  • UpdateFailed
  • Rollbacking
  • RollbackSuccess
  • RollbackFailed
  • Deleting
  • DeleteFailed
  • Unregistering
  • UnRegisterFailed
  • CreateTimeout
  • InitTimeout
  • RegisterTimeout
  • InstallTimeout
  • UpdateTimeout
  • RollbackTimeout
  • DeleteTimeout
  • UnregisterTimeout
  • Starting
  • Freezing
  • Frozen
  • Restarting
  • RestartFail
  • Unhealthy
  • RestartTimeout
  • Resizing
  • ResizeFailed
  • ResizeTimeout

instance_status

Integer

实例状态对应编号

  • 1:创建中
  • 2:创建成功
  • 3:创建失败
  • 4:初始化中
  • 5:注册中
  • 6:运行中
  • 7:初始化失败
  • 8:注册失败
  • 10:安装中
  • 11:安装失败
  • 12:升级中
  • 13:升级失败
  • 20:回滚中
  • 21:回滚成功
  • 22:回滚失败
  • 23:删除中
  • 24:删除失败
  • 25:注销中
  • 26:注销失败
  • 27:创建超时
  • 28:初始化超时
  • 29:注册超时
  • 30:安装超时
  • 31:升级超时
  • 32:回滚超时
  • 33:删除超时
  • 34:注销超时
  • 35:启动中
  • 36:冻结中
  • 37:已冻结
  • 38:重启中
  • 39:重启失败
  • 40:实例异常
  • 41:重启超时
  • 42:规格变更中
  • 43:规格变更失败
  • 44:规格变更超时

枚举值:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 10
  • 11
  • 12
  • 13
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44

type

String

实例类型

默认apig

spec

String

实例规格:

  • BASIC:基础版实例
  • PROFESSIONAL:专业版实例
  • ENTERPRISE:企业版实例
  • PLATINUM:铂金版实例

枚举值:

  • BASIC
  • PROFESSIONAL
  • ENTERPRISE
  • PLATINUM

create_time

Long

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

enterprise_project_id

String

企业项目ID,企业账号必填

eip_address

String

实例绑定的弹性IP地址

charging_mode

Integer

实例计费方式:

  • 0:按需计费
  • 1:暂未使用

枚举值:

  • 0
  • 1

cbc_metadata

String

计费订单编号参数暂未使用

loadbalancer_provider

String

实例使用的负载均衡器类型

  • lvs Linux虚拟服务器
  • elb 弹性负载均衡,elb仅部分region支持

缺省值:lvs

枚举值:

  • lvs
  • elb

description

String

实例描述

vpc_id

String

虚拟私有云ID。

获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。

subnet_id

String

子网的网络ID。

获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询子网列表”章节。

security_group_id

String

指定实例所属的安全组。

获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,在安全组的详情页面查找安全组ID。
  • 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询安全组列表”章节。

maintain_begin

String

'维护时间窗开始时间。时间格式为 xx:00:00,xx取值为02,06,10,14,18,22。'

'在这个时间段内,运维人员可以对该实例的节点进行维护操作。维护期间,业务可以正常使用,可能会发生闪断。维护操作通常几个月一次。'

maintain_end

String

'维护时间窗结束时间。时间格式为 xx:00:00,与维护时间窗开始时间相差4个小时。'

'在这个时间段内,运维人员可以对该实例的节点进行维护操作。维护期间,业务可以正常使用,可能会发生闪断。维护操作通常几个月一次'。

ingress_ip

String

实例入口,虚拟私有云访问地址

ingress_ip_v6

String

实例入口,虚拟私有云访问地址 (IPv6),暂不支持

user_id

String

实例所属用户ID

nat_eip_ipv6_cidr

String

出公网网段 (IPv6) ,暂不支持

eip_ipv6_address

String

弹性IP地址(IPv6),暂不支持

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

node_ipv6_ips

NodeIps object

服务IPV6节点IP,暂不支持

public_ipv6_ips

Array of strings

实例IPV6出公网IP,暂不支持

publicips

Array of IpDetails objects

公网入口地址列表

privateips

Array of IpDetails objects

私网入口地址列表

unreliable_ips

Array of strings

不建议使用的实例入口列表:分组子域名解析未指向到该列表的IP,不能用该列表的IP直接访问DEFAULT分组

enable_fullstack_ipv6

Boolean

实例是否支持全量IPv6,暂不支持

  • true:支持,实例入口和实例出口都支持IPV6
  • false:不支持,仅实例入口支持IPV6

is_releasable

Boolean

实例是否可释放

  • true:可释放
  • false:不可释放

ingress_bandwidth_charging_mode

String

入公网带宽计费模式

表4 EndpointService

参数

参数类型

描述

service_name

String

终端节点服务名称

created_at

String

创建时间

表5 NodeIps

参数

参数类型

描述

livedata

Array of strings

livedata节点IP地址列表

shubao

Array of strings

shubao节点IP地址列表

表6 IpDetails

参数

参数类型

描述

ip_address

String

IP地址

ipv6_address

String

IPV6地址,暂不支持

bandwidth_size

Integer

带宽大小

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

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",
  "nat_eip_ipv6_cidr" : null,
  "eip_ipv6_address" : null,
  "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",
    "ipv6_address" : "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b8",
    "bandwidth_size" : 5
  } ],
  "privateips" : [ {
    "ip_address" : "xxx.xxx.xxx.xxx",
    "ipv6_address" : "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b8",
    "bandwidth_size" : 5
  } ],
  "ingress_bandwidth_charging_mode" : "traffic",
  "cbc_operation_locks" : [ {
    "lock_scene" : "TO_PERIOD_LOCK",
    "lock_source_id" : "CxxxxxxxxxxxM"
  } ],
  "public_ipv6_ips" : [ "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b83", "xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:6fee" ],
  "node_ipv6_ips" : {
    "livedata" : [ ],
    "shubao" : [ "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b81", "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b84" ]
  },
  "enable_fullstack_ipv6" : true,
  "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

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容