You need to enable JavaScript to run this app.
导航
全球加速
  • 文档首页
    • /
  • 全球加速

DescribeIPSet

最近更新时间：2022.09.01 11:30:07

首次发布时间：2022.09.01 11:30:07

我的收藏

API说明

API 名称：DescribeIPSet。
API 域名：open.volcengineapi.com 。
API 描述：查询加速区域。

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2022-03-01 。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例
IPSetId
string
是
加速区域 ID 。
ips-ghdasgh***
AcceleratorIdstring是加速器 ID 。ga-gdash

响应正文

参数类型参数说明示例
IPSet
array of IPSet
加速区域结构。
见 IPSet

IPSet

参数类型参数说明示例
AcceleratorIdstring加速器 ID 。
ga-ghdasgh***
IPSetIdstring加速区域 ID 。ips-gdsahg

IPVersion

string

IP 协议版本，支持取值：

  • IPv4：加速IPv4客户端访问IPv4服务。
  • IPv4/IPv6：加速IPv4/IPv6客户端访问IPv4服务。

IPv4

State

string

加速区域的状态，支持取值：

  • active：正常。
  • deploying：配置中。
  • Inactive：待配置。

active

Bandwidthint带宽大小，单位Mbps。3
AccelerateRegionstring加速区域，支持取值：CN、CN_NorthEast、CN_North、CN_East、CN_South、 CN_Central、CN_NorthWest、CN_SouthWest、AP1。CN_East

示例

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=DescribeIPSet&<其他公共请求参数>
{
    "AcceleratorId":"accinstance-aqx3E74Tz72rNYTgrqF3sj",
    "IPSetId":"CN_NorthEast"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20220806170443010174255181027ECBE7",
        "Action": "DescribeIPSet",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "AcceleratorId": "accinstance-aqx3E74Tz72rNYTgrqF3sj",
        "IPSetId": "CN_NorthEast",
        "IPVersion": "IPv4/IPv6",
        "AccelerateRegion": "东北",
        "State": "active",
        "Bandwidth": 0
    }
}