You need to enable JavaScript to run this app.
导航

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

最近更新时间2023.09.06 11:03:27

首次发布时间2022.07.28 21:39:27

API 说明

API 名称:DescribeContentQuota
API 域名:open.volcengineapi.com
API 描述:指定一个或多个云服务商账号,查询账号的刷新与预热任务的配额及余量。

请求方法

POST

使用限制

  • 节流限制:每秒最多提交 30 个请求。
  • 云服务商 CDN 接口的限制:
    多云CDN调用云服务商 CDN 的相关接口以获取统计分析数据。由于云服务商 CDN 接口能力的限制,多云CDN不支持查询以下 CDN 的刷新与预热任务配额数据:
    • UCloud CDN
    • 七牛云 CDN
    • AWS CloudFront
    • Akamai AMD/DSA

公共查询参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称
数据类型
是否必选
参数说明
Action
String
API 的名称。该参数的取值是 DescribeContentQuota
Version
String
API 的版本。该参数的取值是 2022-03-01

请求正文

参数名称数据类型是否必选参数说明示例
CloudAccountIdString表示云服务商的账号 ID。该账号是在多云CDN中创建的。您可以指定多个账号 ID。多个账号 ID 使用英文逗号(,)分隔。您可以调用 ListCloudAccounts 查询所有云服务商账号 ID。62d4d3f4ew251907cd2ee2c3

响应正文

参数名称
数据类型
参数说明
示例
Quotas
QuotaDetail[]
表示一个云服务商帐号的对象列表。这些账号是在多云CDN中创建的。每个对象对应一个账号的配额信息。对于这些账号,该 API 可以成功获得刷新与预热的配额信息。
VendorsMetaData
ContentVendorMetaData[]
表示一个云服务商帐号的对象列表。这些账号是在多云CDN中创建的。每个对象对应一个账号的云服务商信息。对于这些账号,该 API 无法获得刷新与预热的配额信息。

示例

请求示例

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

响应示例

{
    "ResponseMetadata": {
        "RequestID": "202207231723020102120972292375B97E",
        "Action": "DescribeContentQuota",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "Quotas": [
            {
                "RefreshUrlQuota": 1000,
                "RefreshUrlRemain": 993,
                "RefreshDirQuota": 50,
                "RefreshDirRemain": 43,
                "PreloadQuota": 1000,
                "PreloadRemain": 993,
                "Area": "",
                "Vendor": "volcengine",
                "CloudAccountId": "62d4d3f4ew251907cd2ee2c3",
                "CloudAccountName": "Test",
                "ProductType": "cdn"
            }
        ],
        "VendorsMetaData": []
    }
}

错误代码

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