接口功能介绍
查看IPv4网关详情
接口约束
URI
GET /openapi/v4/vpc/ipv4-gw/show
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 区域ID | 81f7728662dd11ec810800155d307d5b |
| id | String | 否 | IPv4网关的ID, 该字段后续废弃 | igw-1f0tosvtma |
| ipv4GwID | String | 是 | IPv4网关的ID, 推荐使用该字段 | igw-1f0tosvtma |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Object | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| name | String | IPv4网关名称 | igw-for-vpc-dvu6n5gin0 |
| description | String | IPv4网关描述 | 描述 |
| vpcID | String | 虚拟私有云 id | vpc-62cjmqu83m |
| id | String | IPv4网关id | igw-1f0tosvtma |
| routeTableID | String | 关联的网关路由表ID | rtb-nt76686qqt |
| createdAt | String | 创建时间 | 2022-12-12T07:25:30Z |
| updatedAt | String | 更新时间 | 2022-12-12T07:25:30Z |
请求示例
GET /openapi/v4/vpc/ipv4-gw/show?regionID=81f7728662dd11ec810800155d307d5b&id=igw-1f0tosvtma
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"name": "test-for-me",
"description": "",
"vpcID": "vpc-62cjmqu83m",
"id": "igw-1f0tosvtma",
"routeTableID": "rtb-nt76686qqt",
"creatdAt": "2022-12-12T07:25:30Z",
"updateAt": "2022-12-12T07:25:30Z"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
