查询实例详情
更新时间：2026-09-22
该接口用于查询指定 AI 网关实例的详细信息，包括状态、套餐、网络入口、监控和日志配置。
请求结构
Plain Text
1POST /?action=DescribeInstance HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceId": instanceId
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 否 | RequestBody参数 | 网关实例 ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceName | String | 实例名称 |
| instanceId | String | 实例 ID |
| status | String | 状态 |
| expireTime | String | 过期时间 |
| createTime | String | 创建时间 |
| spec | String | 实例规格 |
| podCnt | int | 网关 Pod 数量 |
| blbSpec | String | BLB 规格类型 |
| chargeType | String | 付费类型 |
| publicEnabled | Boolean | 是否开启公网访问 |
| privateEnabled | Boolean | 是否开启私网访问 |
| vpcId | String | 所在 VPC ID |
| vpcName | String | 所在 VPC 名称 |
| subnetIds | List<String> | 所在子网 ID 列表 |
| subnetName | List<String> | 所在子网名称 |
| securityGroupName | String | 安全组名称 |
| securityGroupId | String | 安全组 ID |
| publicIp | String | 公网 IP |
| eipId | String | 绑定的 EIP ID |
| publicPort | String | 公网端口 |
| internalIp | String | 内网 IP |
| intranetPort | String | 内网端口 |
| cpromId | String | CProm 监控 ID |
| blsConfig | BlsModel | BLS 日志收集配置 |
| otelConfig | OtelModel | OTel 链路追踪配置 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源，请确认使用正确的账号凭证且资源属于当前账号 |
| InstanceNotExist | Instance not exist. | 404 | 实例不存在、不属于当前账号或已释放 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribeInstance HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "instanceId": "gw-a1b2c3d4"
7}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "instanceName": "生产网关",
9 "instanceId": "gw-a1b2c3d4",
10 "status": "Active",
11 "expireTime": "2027-09-01T08:00:00Z",
12 "createTime": "2026-09-01T08:00:00Z",
13 "spec": "spec-1",
14 "podCnt": 2,
15 "blbSpec": "medium1",
16 "chargeType": "Postpaid",
17 "publicEnabled": true,
18 "privateEnabled": false,
19 "vpcId": "vpc-a1b2c3d4",
20 "vpcName": "生产网络",
21 "subnetIds": [
22 "sbn-a1b2c3d4"
23 ],
24 "subnetName": "生产子网",
25 "securityGroupName": "aigw-sg",
26 "securityGroupId": "g-a1b2c3d4",
27 "publicIp": "100.88.13.115",
28 "eipId": "eip-a1b2c3d4",
29 "publicPort": "443",
30 "internalIp": "192.168.1.10",
31 "intranetPort": "80",
32 "cpromId": "cprom-1",
33 "blsConfig": {
34 "enableBls": true,
35 "enablePluginLog": false
36 },
37 "otelConfig": {
38 "enableOtel": false
39 }
40}评价此篇文章