查询指定加速区域的 IP 协议、公网类型、运行状态及已分配的加速 IP。适用于获取客户端接入地址和区域网络配置。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeIPSet | 要执行的操作,取值: DescribeIPSet。 |
Version | String | 是 | 2022-03-01 | API 的版本,取值: 2022-03-01。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
AcceleratorId | String | 是 | accinstance-YfiSM6k5BspFcC4BaG**** | 指定待查询加速器的 ID。可通过调用 ListAccelerators 接口获取当前账号下的加速器 ID。 |
IPSetId | String | 是 | CN_South | 指定待查询加速区域的 ID。取值:
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
IPAddressList | Object | 该加速区域分配的加速 IP 列表,按 IP 协议版本分组。 | |
IspType | String | Standard | 加速区域的公网类型。取值:
|
IPVersion | String | IPv4/IPv6 | 加速区域支持客户端接入的 IP 协议版本。取值:
|
IPSetId | String | CN_South | 加速区域对应的 ID。 |
AcceleratorId | String | accinstance-YfiSM6k5BspFcC4BaG**** | 加速器的 ID。 |
AccelerateRegion | String | 华南 | 加速区域的中文名称,与 IPSetId 一一对应。 |
State | String | active | 加速区域的状态。取值:
|
POST https://ga.volcengine-api.com?Action=DescribeIPSet&Version=2022-03-01 { "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****", "IPSetId": "CN_South" }
{ "ResponseMetadata": { "RequestId": "202306041104201234100232280022D31", "Action": "DescribeIPSet", "Version": "2022-03-01", "Service": "ga", "Region": "cn-beijing" }, "Result": { "IPAddressList": { "IPV4s": [ { "Addr": "203.0.113.1", "ISP": "ChinaUnicom", "ISPName": "联通" } ], "IPV6s": [ { "Addr": "2001:db8::1", "ISP": "ChinaUnicom", "ISPName": "联通" } ] }, "IspType": "Standard", "IPVersion": "IPv4/IPv6", "IPSetId": "CN_South", "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****", "AccelerateRegion": "华南", "State": "active" } }
本接口无专用错误码。公共错误码请参见公共错误码。