按云服务商查询刷新与预热任务配额--多云CDN-火山引擎

文档中心

立即注册

导航

按云服务商查询刷新与预热任务配额

最近更新时间：2024.08.23 17:21:11首次发布时间：2022.07.28 21:39:27

调用本接口查询指定云服务商账号的刷新和预热任务配额及余量。
多云CDN调用云服务商提供的刷新与预热任务配额查询接口，以获取相关数据。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制。

使用限制

节流限制：您每秒最多可以提交 30 个 API 请求。
云服务商平台接口限制：
以下云服务商产品不支持刷新与预热任务配额查询功能：
- 腾讯云—EdgeOne
- Google Cloud—Media CDN
- 中国移动—CDN
- Azure—CDN

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
CloudAccountId	String	是	指定要查询的云服务商账号的 ID。您可以指定一个或多个账号 ID。多个账号 ID 之间使用半角逗号（,）分隔。说明您可以调用 ListCloudAccounts 接口查询多云CDN中的所有云服务商账号 ID。	`655372daa21faa599668****`

响应正文

参数名称	数据类型	参数说明	示例
Quotas	Object[]	从云服务商平台获得的刷新和预热任务配额信息。
VendorsMetaData	Object[]	多云CDN未能从云服务商平台获得任务配额信息的情形下，所返回的原始请求信息。

请求示例

POST https://open.volcengineapi.com/?Action=DescribeContentQuota&Version=2022-03-01&<其他公共请求参数>=
{
    "CloudAccountId": "655372daa21faa599668****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202402191705048E2CAAFB495BA25A9170",
        "Action": "DescribeContentQuota",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Quotas": [
            {
                "RefreshUrlQuota": 2000000,
                "RefreshUrlRemain": 1999096,
                "RefreshDirQuota": 10000,
                "RefreshDirRemain": 9370,
                "PreloadQuota": 10000000,
                "PreloadRemain": 9999536,
                "Area": "",
                "Vendor": "volcengine",
                "CloudAccountId": "655372daa21faa599668****",
                "CloudAccountName": "volctest",
                "ProductType": "cdn",
                "SubProduct": "cdn"
            },
            {
                "RefreshUrlQuota": 10000,
                "RefreshUrlRemain": 10000,
                "RefreshDirQuota": 100,
                "RefreshDirRemain": 100,
                "PreloadQuota": 1000,
                "PreloadRemain": 1000,
                "Area": "",
                "Vendor": "volcengine",
                "CloudAccountId": "655372daa21faa599668****",
                "CloudAccountName": "volctest",
                "ProductType": "dcdn",
                "SubProduct": "dcdn"
            }
        ],
        "VendorsMetaData": []
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。