最近更新时间:2022.09.01 11:30:06
首次发布时间:2022.09.01 11:30:06
API 名称:ListAccelerators 。
API 域名:open.volcengineapi.com 。
API 描述:列举加速器列表。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数。
名称 | 类型 | 是否必选 | 格式 | 说明 |
---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称。 |
Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2022-03-01 。 |
在使用该 API 提交请求时,请求正文中可以包含的参数如下。
参数 | 类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
AcceleratorId | string | 否 | 加速器 ID 。 | ga-ghdasgh*** |
PageNum | int | 否 | 页码,默认是1。 | 1 |
PageSize | int | 否 | 页面大小,默认为10。 | 10 |
State | string | 否 | 加速器状态,支持取值:
| active |
参数 | 类型 | 参数说明 | 示例 |
---|---|---|---|
TotalCount | int | 加速器总个数。 | 5 |
PageNum | int | 页码,默认1。 | 1 |
PageSize | int | 页面大小,默认10。 | 10 |
Accelerators | array of Accelerator | 加速器列表。 | 见 Accelerator 。 |
Accelerator
参数 | 类型 | 参数说明 | 示例 |
---|---|---|---|
AcceleratorId | string | 加速器 ID 。 | ga-ghdasgh*** |
CreateTime | long | 创建加速器的时间,时间戳。 | 1643155486 |
ExpiredTime | long | 加速器过期的时间,时间戳。 | 1643155486 |
Name | string | 加速器的名称。 | test_pf |
State | string | 加速器的状态。 | active |
CNAME | string | 加速器的 CNAME 。 | ga-sgdah... |
Type | string | 加速器的类型。 | Standard |
ListenerCount | int | 一个加速器下面的监听数量。 | 1 |
AccountID | string | 账户ID | 2100055193 |
CrossDomainBandwidthIds | array of string | 加速器绑定的带宽包ID。 | ["cdb-ubsv5kWeACZbUYYWXBgYKQ"] |
POST https://open.volcengineapi.com/?Version=2022-03-01&Action=ListAccelerators&<其他公共请求参数> { "PageNum":1, "PageSize":2 }
{ "ResponseMetadata": { "RequestId": "20220805213516010225146063084E3389", "Action": "ListAccelerators", "Version": "2022-03-01", "Service": "ga", "Region": "cn-north-1" }, "Result": { "Accelerators": [ { "AcceleratorId": "accinstance-w9jhhhawiro4GW8YD4hp2o", "CreateTime": 1659581528, "ExpiredTime": 0, "Name": "test-1", "State": "active", "CNAME": "accelerator-cname-w9tYv7WizwZqkaf4555bJA.c.qa-boe.dsa.msadhbui21.com", "Type": "", "ListenerCount": 1, "AccountID": "2100055193" }, { "AcceleratorId": "accinstance-VfW3ccQhuJXe7M3XP8oBmX", "CreateTime": 1659497416, "ExpiredTime": 0, "Name": "test-2", "State": "inactive", "CNAME": "accelerator-cname-LwPMWGAAZMSu9j5TLGuC5P.c.qa-boe.dsa.msadhbui21.com", "ListenerCount": 0, "AccountID": "2100055193", "CrossDomainBandwidthIds": [ "cdb-ubsv5kWeACZbUYYWXBgYKQ" ] } ], "TotalCount": 43, "PageSize": 2, "PageNum": 1 } }