Help & DocumentationAPIsCloud Block StorageCloud Disk APIsDescribeDiskOperationLogs

DescribeDiskOperationLogs

Last updated: 2020-04-03 10:29:13

1. API Description

Domain name for API request: cbs.tencentcloudapi.com.

This API (DescribeDiskOperationLogs) is used to query a list of cloud disk operation logs.

This can be filtered according to the cloud disk ID. The format of cloud disk IDs is as follows: disk-a1kmcp13.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cbs.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

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 parameter. The value used for this API: DescribeDiskOperationLogs.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Filters.N Yes Array of Filter Filter conditions. The following conditions are supported:
  • disk-id - Array of String - Required or not: Yes - Filter by cloud disk ID, with maximum of 10 cloud disk IDs able to be specified per request.
    		•
    BeginTime No Timestamp The start time of the operation logs to be queried, for example: “2019-11-22 00:00:00"
    EndTime No Timestamp The end time of the operation logs to be queried, for example: “2019-11-22 23:59:59"

    3. Output Parameters

    Parameter Name Type Description
    DiskOperationLogSet Array of DiskOperationLog List of cloud disk operation logs.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying Cloud Disk Operation Log

    Input Example

    https://cbs.tencentcloudapi.com/?Action=DescribeDiskOperationLogs
&Filters.0.Name=disk-id
&Filters.0.Values.0=disk-ou4acu4i
&<common request parameters>

    Output Example

    {
  "DiskOperationLogSet": [
    {
      "OperationState": "SUCCESS",
      "StartTime": "2018-09-19 20:40:20",
      "Operator": "100004375281",
      "Operation": "CBS_OPERATION_MODIFY",
      "EndTime": "2018-09-19 20:40:20",
      "DiskId": "disk-ou4acu4i"
    },
    {
      "OperationState": "SUCCESS",
      "StartTime": "2018-09-19 20:40:16",
      "Operator": "100004375281",
      "Operation": "CBS_OPERATION_MODIFY",
      "EndTime": "2018-09-19 20:40:16",
      "DiskId": "disk-ou4acu4i"
    },
    {
      "OperationState": "SUCCESS",
      "StartTime": "2018-09-19 20:40:13",
      "Operator": "100004375281",
      "Operation": "CBS_OPERATION_EXPAND",
      "EndTime": "2018-09-19 20:40:13",
      "DiskId": "disk-ou4acu4i"
    },
    {
      "OperationState": "SUCCESS",
      "StartTime": "2018-09-19 20:39:59",
      "Operator": "100004375281",
      "Operation": "CBS_OPERATION_CREATE",
      "EndTime": "2018-09-19 20:39:59",
      "DiskId": "disk-ou4acu4i"
    }
  ]
}

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError.ComponentError Dependent component request failed. Please contact customer service.
    InvalidDiskId.NotFound The ‘DiskId’ entered does not exist.
    InvalidParameter Invalid parameter
    InvalidParameterValue Invalid parameter value. Parameter value format error or parameter value not supported.
    InvalidParameterValue.LimitExceeded Number of parameter values exceeds the limit.
    MissingParameter Missing parameter. Request does not include the required parameter.