全域弹性公网IP支持绑定的Region限制 - ListSupportRegions
功能介绍
全域弹性公网IP支持绑定的Region限制。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v3/{domain_id}/geip/support-regions
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 租户账号ID,获取租户账号ID请参见租户账号ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 最小长度:5 最大长度:32 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页条数。 约束限制: 不涉及。 取值范围: 0-2000 默认取值: 不涉及。 最小值:0 最大值:2000 |
| offset | 否 | Integer | 参数解释: 分页查询起始的资源序号。 约束限制: 不涉及。 取值范围: 0-2000 默认取值: 不涉及。 |
| marker | 否 | String | 参数解释: 上一页最后一条记录的ID。 约束限制: 取值范围: 格式:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} 默认取值: 不涉及。 |
| page_reverse | 否 | Boolean | 参数解释: 翻页方向。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| fields | 否 | Array of strings | 参数解释: 查询指定的字段。 约束限制: 格式为fields=A&fields=B&fields=C&...... 取值范围: 支持的字段: 默认取值: 不涉及。 |
| sort_key | 否 | Array of strings | 参数解释: 按照sort_key指定的字段排序。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| sort_dir | 否 | Array of strings | 参数解释: 排序方向。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| id | 否 | Array of strings | 参数解释: 根据ID过滤,支持多值查询。 约束限制: 查询条件格式:id=xxx&id=xxx。 取值范围: 格式:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} 默认取值: 不涉及。 |
| instance_type | 否 | Array of strings | 参数解释: 根据支持绑定的实例类型过滤。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| public_border_group | 否 | Array of strings | 参数解释: 表示中心站点资源或者边缘站点资源。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| access_site | 否 | Array of strings | 参数解释: 接入点信息,具体接入点信息可通过查询接入点列表接口查询。 约束限制: 根据接入点过滤,支持多值查询,查询条件格式:access_site=xxx&access_site=xxx。 取值范围: 不涉及。 默认取值: 不涉及。 |
| region_id | 否 | Array of strings | 参数解释: 根据region_id过滤。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| remote_endpoint | 否 | Array of strings | 参数解释: query by remote_endpoint 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| status | 否 | Array of strings | 参数解释: 根据全域弹性公网IP状态过滤。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户的Token,如何获取用户Token请参见获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Request-Id | String | 本次请求编号 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 请求ID。 取值范围: 不涉及。 |
| support_regions | Array of ListSupportRegions objects | 参数解释: 支持的Region对象。 取值范围: 不涉及。 |
| page_info | page_info object | 参数解释: 分页页码信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 全域弹性公网IP支持绑定的Region的ID。 取值范围: 不涉及。 |
| instance_type | String | 参数解释: 支持绑定的实例类型。 取值范围: 不涉及。 |
| access_site | String | 参数解释: 接入点信息,具体接入点信息可通过查询接入点列表接口查询。 取值范围: 不涉及。 |
| region_id | String | 参数解释: 局点的id。 取值范围: 不涉及。 |
| public_border_group | String | 参数解释: 表示中心站点资源或者边缘站点资源。 取值范围: 最小长度:1 最大长度:64 |
| remote_endpoint | String | 参数解释: 下一跳地址。 取值范围: 不涉及。 |
| status | String | 参数解释: 状态。 取值范围: |
| created_at | String | 参数解释: 创建时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
| updated_at | String | 参数解释: 更新时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
请求示例
全域弹性公网IP支持绑定的Region限制
GET https://{Endpoint}/v3/{domain_id}/geip/support-regions 响应示例
状态码:200
{
"request_id" : "d224afc0e7add65c715707dbadd3004a",
"support_regions" : [ {
"id" : "0eb4d1ce-c7f1-447d-85a2-dbe9c7c360a8",
"status" : "active",
"created_at" : "2023-04-17T07:41:50Z",
"updated_at" : "2023-07-08T03:22:07Z",
"instance_type" : "IPV6-PORT",
"region_id" : "cn-southwest-242",
"public_border_group" : "center",
"access_site" : "cn-south-odin",
"remote_endpoint" : "https://eip-internal.cn-southwest-242.myhuaweicloud.com"
}, {
"id" : "108f97b3-ab96-45bc-8c8e-1db586ed3752",
"status" : "active",
"created_at" : "2023-04-03T07:56:39Z",
"updated_at" : "2023-07-08T03:22:23Z",
"instance_type" : "ECS",
"region_id" : "cn-southwest-242",
"public_border_group" : "center",
"access_site" : "cn-south-odin",
"remote_endpoint" : "https://eip-internal.cn-southwest-242.myhuaweicloud.com"
} ],
"page_info" : {
"previous_marker" : "0eb4d1ce-c7f1-447d-85a2-dbe9c7c360a8",
"current_count" : 2
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。