All Products
Search

This Product

    CDN:CreateUserUsageDataExportTask

    Document Center

    CDN:CreateUserUsageDataExportTask

    Last Updated:Mar 28, 2024

    Creates a task to export your resource usage history to a PDF file.

    Operation description

    • You can create a task to query data in the last year. The maximum time range that can be queried is one month.
    • You can call this operation up to 100 times per second per account.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cdn:CreateUserUsageDataExportTaskWRITE
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    StartTimestringYes

    The start of the time range to query. The data is collected every 5 minutes.

    Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    		2015-12-10T20:00:00Z
    EndTimestringYes

    The end of the time range to query. The end time must be later than the start time.

    Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    		2015-12-10T21:00:00Z
    TaskNamestringNo

    The name of the task.

    		Refresh
    LanguagestringNo

    The language in which you want to export the file. Default value: zh-cn. Valid values:

    • zh-cn: Chinese
    • en-us: English
    		zh-cn

    Response parameters

    ParameterTypeDescriptionExample
    object
    EndTimestring

    The end of the time range during which data was queried.

    		2015-12-10T21:00:00Z
    StartTimestring

    The start of the time range during which data was queried.

    		2015-12-10T20:00:00Z
    RequestIdstring

    The ID of the request.

    		ED61C6C3-8241-4187-AAA7-5157AE175CEC
    TaskIdstring

    The ID of the task.

    		129456

    Examples

    Sample success responses

    JSONformat

    {
  "EndTime": "2015-12-10T21:00:00Z",
  "StartTime": "2015-12-10T20:00:00Z",
  "RequestId": "ED61C6C3-8241-4187-AAA7-5157AE175CEC",
  "TaskId": "129456"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
    400InvalidStartTime.MalformedThe specified StartTime is invalid.The format of the start time is invalid. Specify a valid value.
    400InvalidEndTime.MalformedThe specified EndTime is invalid.The EndTime parameter is set in an invalid format. For more information, see the API references.
    400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid. For more information, see the API references.
    400InvalidParameterProductInvalid Parameter Product.The Product parameter is set to an invalid value.
    400InvalidParameterAliuidInvalid Parameter Aliuid.The Aliuid parameter is set to an invalid value.
    400InvalidParameterStartTimeThe parameter StartTime is invalid.The specified StartTime parameter is invalid.
    400InvalidParameterEndTimeThe parameter EndTime is invalid.-
    400InvalidTimeRangeInvalid StartTime and EndTime range.The specified time range is invalid.
    400InvalidParameterOperatorInvalid Parameter Operator.The Operator parameter is set to an invalid value.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-06-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change