分页查询标准型加速器的配置、状态和关联资源信息,并可按 ID、名称、状态、规格、计费方式、项目或标签筛选。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListAccelerators | 要执行的操作,取值: ListAccelerators。 |
Version | String | 是 | 2022-03-01 | API 的版本,取值: 2022-03-01。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
AcceleratorId | String | 否 | accinstance-YfiSM6k5BspFcC4BaG**** | 加速器的 ID。指定后仅返回该 ID 对应的加速器信息;不指定则返回符合其余筛选条件的全部加速器。 |
State | String | 否 | active | 按加速器状态筛选。取值:
|
ChargeType | String | 否 | PREPAY | 按计费方式筛选。取值:
|
BillingSpec | String | 否 | small | 按加速器规格筛选。不同规格的具体能力,参见计费概述。取值:
|
PageSize | Integer | 否 | 10 | 分页查询时每页返回的最大条目数。默认值为 10,最大值为 100。 |
PageNum | Integer | 否 | 1 | 分页查询的页码。默认值为 1。 |
ProjectName | String | 否 | test-project | 按资源所属项目筛选,仅返回该项目下的加速器。项目是火山引擎通用的资源管理工具,用于对账号下的云资源进行分组管理与权限隔离。 |
ResourceTagFilter | Object | 否 | 按资源标签筛选加速器。通过 FilterType 指定多标签的组合逻辑,通过 ResourceTags 给出用于筛选的标签集合。 | |
Name | String | 否 | accelerator-sh-hk | 按加速器名称筛选,支持传入名称包含的关键字进行模糊匹配。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Accelerators | Object[] | 符合筛选条件的加速器列表,每个元素为一个加速器的详细信息。 | |
PageNum | Integer | 1 | 本次返回结果的页码。 |
PageSize | Integer | 10 | 本次响应的每页条目数。 |
TotalCount | Integer | 20 | 符合查询条件的加速器总数。 |
POST https://ga.volcengine-api.com?Action=ListAccelerators&Version=2022-03-01 { "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****", "State": "active", "ChargeType": "PREPAY", "BillingSpec": "small", "PageSize": 10, "PageNum": 1 }
{ "ResponseMetadata": { "RequestId": "202410161753390292202441551F1436", "Action": "ListAccelerators", "Version": "2022-03-01", "Service": "ga", "Region": "cn-beijing" }, "Result": { "Accelerators": [ { "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****", "AccountID": "210005XXXX", "Name": "test", "State": "active", "CNAME": "accelerator-cname-kaiinhy47zndzbruhnrjn5.c.example.com", "ChargeType": "PREPAY", "BillingSpec": "small", "BandwidthPackageIds": [ "gbwp-RTw5UPU3k2n4mfDYsC****" ], "CrossDomainBandwidthIds": [ "crb-6PYMjSLm9xrFuBJrpx****" ], "RenewType": 0, "FullPortSwitch": true, "RegionCount": 1, "ListenerCount": 1, "CreateTime": 1717127658, "BillingSpecEffectiveTime": 1717127658, "ExpiredTime": 1719719658, "ProjectName": "default", "BillingType": "PayByTrafficMonthly", "ResourceTags": [ { "Key": "bc", "Value": "nV645nc" } ], "IPSets": [ { "IPVersion": "IPv4/IPv6", "IPSetId": "CN_South", "AccelerateRegion": "华南", "State": "active", "IspType": "Standard", "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****", "IPAddressList": { "IPV4s": [ { "Addr": "203.0.113.1", "ISP": "ChinaUnicom", "ISPName": "联通" } ], "IPV6s": [ { "Addr": "2001:db8::1", "ISP": "ChinaUnicom", "ISPName": "联通" } ] } } ] } ], "PageNum": 1, "PageSize": 10, "TotalCount": 10 } }
本接口无专用错误码。公共错误码请参见公共错误码。