查询指定标准型加速器信息DescribeAccelerator--全球加速-火山引擎

文档中心

立即注册

导航

查询指定标准型加速器信息DescribeAccelerator

最近更新时间：2024.10.16 16:26:26首次发布时间：2024.08.07 14:36:38

本接口用于查询指定标准型加速器信息。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DescribeAccelerator&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeAccelerator`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
AcceleratorId	String	是	标准型加速器 ID。	`accinstance-xxxxxxxx`

返回参数

参数名称	数据类型	参数说明	示例
AcceleratorId	String	标准型加速器 ID 。	`accinstance-xxxxxxxx`
AccountID	String	账号 ID 。	`2100xx`
Name	String	标准型加速器名称。	`test`
State	String	标准型加速器的状态。支持的值如下： active:运行中。 inactive：待配置。 deploying：配置中。 overdue：欠费中。 expired：已过期。	`active`
CNAME	String	标准型加速器的 CNAME 。	`xxxx`
ChargeType	String	标准型加速器的计费类型。 PREPAY：预付费。 POSTPAY：后付费。	`POSTPAY`
BillingType	String	ChargeType 为 POSTPAY时，即标准型加速器计费类型为后付费时，显示该加速器的付费方式。 PayByTrafficDaily：按日流量后付费。 PayByTrafficMonthly：按月流量后付费。 PayByBandwidthMonthly：按月95峰值带宽后付费。	`PayByTrafficMonthly`
BillingSpec	String	标准型加速器规格。不同类型加速器的具体规格，参见计费描述（预付费加速器和后付费加速器的规格描述相同）。具体取值如下： small：小型加速器。 middle：中型加速器。 large：大型加速器。	`small`
BandwidthPackageIds	String[]	标准型加速器绑定的公网带宽包 ID 列表。	`["gbwp-xx"]`
CrossDomainBandwidthIds	String[]	标准型加速器绑定的跨域带宽包 ID 列表。	`["crb-xx"]`
RenewType	Integer	标准型加速器的续费类型，具体取值如下： 0：该加速器的计费类型是后付费，不涉及续费。 1：该加速器的计费类型是预付费，续费类型是手动续费。 2：该加速器的计费类型是预付费，续费类型是自动续费。	`0`
FullPortSwitch	Boolean	端口模式。 false：默认模式， true：全端口模式。（全端口模式仅白名单用户可用，如需了解，请联系客户经理）。	`false`
RegionCount	Integer	该加速器下，创建的加速区域数量。	`1`
ListenerCount	Integer	该加速器下，创建的监听数量。	`10`
CreateTime	Integer	创建标准型加速器的时间，用 Unix 时间戳表示，时间日期表示到秒。	`1717127658`
BillingSpecEffectiveTime	Integer	计费生效时间，用 Unix 时间戳表示，时间日期表示到秒。	`1717127658`
ExpiredTime	Integer	过期时间，用 Unix 时间戳表示，时间日期表示到秒。仅 ChargeType 为 PREPAY时，即标准型加速器计费类型为预付费时显示。	`1719719658`
ProjectName	String	加速器所属项目。	`default`
ResourceTags	Object	自定义标签的内容。	`-`

请求示例

POST https://open.volcengineapi.com?Action=DescribeAccelerator&Version=2022-03-01
{
    "AcceleratorId": "accinstance-xxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeAccelerator",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "AcceleratorId": "accinstance-xxxxxxxx",
        "CreateTime": 1717127658,
        "CrossDomainBandwidthIds": [
            "crb-xxx"
        ],
        "BillingType": "PayByTrafficMonthly",
        "BillingSpec": "small",
        "ExpiredTime": 1719719658,
        "FullPortSwitch": false,
        "BillingSpecEffectiveTime": 1717127658,
        "ChargeType": "POSTPAY",
        "BandwidthPackageIds": [
            "gbwp-xx"
        ],
        "Name": "test",
        "RenewType": 0,
        "RegionCount": 1,
        "State": "active",
        "CNAME": "xxxx",
        "ListenerCount": 10,
        "AccountID": "2100xxx"
    }
}