获取用量导出任务列表--内容分发网络-火山引擎

文档中心

立即注册

导航

获取用量导出任务列表

最近更新时间：2024.10.09 16:53:51首次发布时间：2022.10.31 16:28:43

获取用量报告的导出任务的列表。您可以指定过滤条件对任务列表进行过滤。在任务列表中，您可以获取用量报告的下载 URL。

使用限制

节流限制：您每秒最多可以发送 20 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=ListUsageReports&Version=2021-03-01

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
ExportType	String	否	表示任务的类型，用于对任务列表进行过滤。该参数的取值如下： `domain`：表示类型是 "域名明细"。 `account`：表示类型是 "账户明细"。如果不指定该参数，表示不使用该参数对任务列表进行过滤。	`domain`
PageNum	Long	否	表示一个页码，该 API 返回该页上的那些任务。基于 `PageSize`，该 API 对符合过滤条件的任务进行分页。假设符合过滤条件的任务数量是 95，您指定的 `PageSize` 是 `10`，那么这些任务是分布在 10 个页上。如果您指定的 `PageNum` 是 `2`，该 API 返回第 2 页上的那些任务。如果您指定的页上没有任务，则该 API 不返回任何任务。响应正文中 `UsageReportsDetails` 的值为 `null`。 `PageNum` 的默认值是 `1`。	`1`
PageSize	Long	否	表示每页上的任务数量。该参数的默认值是 `10`。	`5`
Status	Long	否	表示一个任务状态，用于对任务列表进行过滤。该参数的取值如下： `0`：表示状态是 "已完成"。 `1`：表示状态是 "创建中"。 `-1`：表示状态是 "创建失败"。如果不指定该参数，表示不使用该参数对任务列表进行过滤。	`1`
TaskName	String	否	表示一个名称，用于对任务列表进行过滤。在使用该参数过滤任务列表时，该 API 使用模糊匹配，获取名称中包含 `TaskName` 的那些任务。如果不指定该参数，表示不使用该参数对任务列表进行过滤。	`acc`

返回参数

参数名称	数据类型	参数说明	示例
PageNum	Long	表示请求参数中的 `PageNum`。	`1`
PageSize	Long	表示请求参数中的 `PageSize`。	`5`
Total	Long	表示符合过滤条件的任务数量。	`3`
UsageReportsDetails	Object[]	表示符合过滤条件的任务列表。

请求示例

POST https://cdn.volcengineapi.com/?Action=ListUsageReports&Version=2021-03-01
{
    "ExportType": "domain",
    "Status": 0,
    "TaskName": "my"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240612184521258FCBC822B141124C74",
        "Action": "ListUsageReports",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "PageNum": 1,
        "PageSize": 10,
        "Total": 1,
        "UsageReportsDetails": [
            {
                "AccountId": "2100003464",
                "BillingCode": "",
                "BillingRegion": "Global",
                "CalculationMethod": "sum_hourly",
                "CreateTime": 1716991132,
                "DownLoadUrl": "URL1",
                "EndTime": 1711455380,
                "ExportType": "topic",
                "Metric": "tls_requests",
                "StartTime": 1711454380,
                "Status": 0,
                "TaskId": "1c69515c3b004f939647a6eba4179e0a",
                "TaskName": "why-sdk-test",
                "TimeZone": "Etc/GMT-8"
            }
        ]
    }
}

错误码

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