Domain name for API request: vod.tencentcloudapi.com.
This API is used to query VOD storage usage in bytes within the query period.
1. You can only query storage usage for the last 365 days.
2. The query period is up to 90 days.
3. The query period at minute-level granularity is up to 7 days.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeStorageDetails. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
Region | No | String | Common Params. This parameter is not required. |
StartTime | Yes | String | Start time in ISO 8601 format. For more information, please see ISO date format. |
EndTime | Yes | String | End time in ISO 8601 format, which should be larger than the start time. For more information, please see ISO date format. |
SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
Interval | No | String | Time granularity. Valid values: The value is set according to query period length by default. 5-minute granularity is set for periods no longer than 1 day, and 1-day granularity is set for periods longer than 1 day. |
StorageType | No | String | Queryed storage type, valid values: The default value is TotalStorage. |
Area | No | String | Storage region to query. Valid values: Default value: Chinese Mainland |
Parameter Name | Type | Description |
---|---|---|
Data | Array of StatDataItem | Storage statistics with one piece of data for every 5 minutes or 1 day. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the storage usage between December 1, 2018 (inclusive) and December 7, 2018 (inclusive).
https://vod.tencentcloudapi.com/?Action=DescribeStorageDetails
&StartTime=2018-12-01T00:00:00+08:00
&EndTime=2018-12-07T00:00:00+08:00
&Area=Chinese Mainland
&<Common request parameters>
{
"Response": {
"Data": [
{
"Time": "2018-12-01T00:00:00+08:00",
"Value": 1000000
},
{
"Time": "2018-12-02T00:00:00+08:00",
"Value": 1500000
},
{
"Time": "2018-12-03T00:00:00+08:00",
"Value": 1500000
},
{
"Time": "2018-12-04T00:00:00+08:00",
"Value": 1500000
},
{
"Time": "2018-12-05T00:00:00+08:00",
"Value": 1500000
},
{
"Time": "2018-12-06T00:00:00+08:00",
"Value": 1500000
},
{
"Time": "2018-12-07T00:00:00+08:00",
"Value": 1500000
}
],
"RequestId": "requestId"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
FailedOperation.InvalidVodUser | The VOD service is not activated. |
InternalError | Internal error. |
InternalError.TimeParseError | An error occurred while parsing the time. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue.Area | Invalid Area . |
InvalidParameterValue.EndTime | Incorrect parameter value: invalid EndTime . |
InvalidParameterValue.StartTime | Incorrect parameter value: invalid StartTime . |
InvalidParameterValue.StorageType | Incorrect parameter value: StorageType. |
InvalidParameterValue.TimeType | Incorrect parameter value: TimeType. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?