调用CreateUsageDetailDataExportTask创建用量明细数据导出任务,将详细用量生成Excel文件用于下载。
接口说明
- 最长可创建查询近一年数据的任务,单次导出任务跨度最长为一个月。
- 单用户调用频率:100 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cdn:CreateUsageDetailDataExportTask | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainNames} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
StartTime | string | 是 | 获取数据起始时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 | 2019-12-10T20:00:00Z |
EndTime | string | 是 | 获取数据结束时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需晚于起始时间。
| 2019-12-10T21:00:00Z |
Group | string | 否 | 域名组信息。如果该信息不为空,则忽略 DomainNames 字段。 | xxx |
DomainNames | string | 否 | 如果域名组为空,则以该字段提供的域名为准导出数据。 如果未填写该参数,则导出用户维度数据。 | example.com |
Type | string | 是 | 需要获取的用量类型。取值:
| flow |
TaskName | string | 否 | 任务名称。 | 刷新 |
Language | string | 否 | 导出文件的语言。取值:
| en-us |
返回参数
示例
正常返回示例
JSON
格式
{
"EndTime": "2015-12-10T21:00:00Z",
"StartTime": "2015-12-10T20:00:00Z",
"RequestId": "ED61C6C3-8241-4187-AAA7-5157AE175CEC",
"TaskId": "123456"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | 请同时提供开始时间和结束时间。 |
400 | InvalidStartTime.Malformed | The specified value of parameter StartTime is malformed. | 开始时间格式错误。日期格式请参考所调用API的帮助文档说明。 |
400 | InvalidEndTime.Malformed | The specified value of parameter EndTime is malformed. | 参数EndTime格式错误。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 开始时间设置错误,请检查更新后重试。 |
400 | InvalidParameterProduct | Invalid Parameter Product. | Product参数错误 |
400 | InvalidParameterDimension | The parameter Dimension is invalid. | Dimension 参数错误,请传入文档提供的参数值。 |
400 | InvalidParameterBillType | The parameter BillType is invalid. | 用户账单类型错误,请确认账单类型符合该查询方式。 |
400 | InvalidParameterAliuid | Invalid Parameter Aliuid. | Aliuid参数错误 |
400 | InvalidParameterStartTime | The specified StartTime is invalid. | 参数StartTime不合法,请根据请求参数规定重新输入。 |
400 | InvalidParameterEndTime | The specified EndTime is invalid. | 参数EndTime不合法,请根据请求参数规定重新输入。 |
400 | InvalidTimeRange | Invalid StartTime and EndTime range. | 开始时间和结束时间范围无效。 |
400 | InvalidParameterOperator | Invalid Parameter Operator. | Operator参数错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-13 | OpenAPI 错误码发生变更 | 查看变更详情 |