DescribeInstanceOperations

Last updated: 2019-09-09 21:30:37

1. API Description

API domain name: es.tencentcloudapi.com.

This API queries the activity records for the specified instance by the specified criteria.

Default API request rate limit: 20 requests/sec.

Note: This API supports financial regions. As financial regions and non-financial regions are isolated, if a financial region, such as ap-shanghai-fsi, is assigned to the common parameter Region, we recommend you include that financial region in your domain name , such as es.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The name of this API: DescribeInstanceOperations
Version Yes String Common parameter. The version of this API: 2018-04-16
Region Yes String Common parameter. For more information, see the list of regions supported by the product.
InstanceId Yes String Cluster instance ID
StartTime Yes String Start time, such as "2019-03-07 16:30:39"
EndTime Yes String End time, such as "2019-03-30 20:18:03"
Offset Yes Integer Pagination start value
Limit Yes Integer Number of entries per page

3. Output Parameters

Parameter name Type Description
TotalCount Integer Total number of activities
Operations Array of Operation Activity record
RequestId String The unique ID of a request, which is required for each troubleshooting case.

4. Examples

Example 1. Querying the Activity Record of an ES Cluster Instance

Input Sample Code

https://es.tencentcloudapi.com/?Action=DescribeInstanceOperations
&InstanceId=es-f5mwm28u
&StartTime=2019-01-30 20:18:03
&EndTime=2019-03-30 20:18:03
&Offset=0
&Limit=30
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "TotalCount": 1,
    "Operations": [
      {
        "Id": 6173,
        "StartTime": "2019-03-07 16:30:39",
        "Type": "CreateInstance",
        "Detail": {
          "OldInfo": [],
          "NewInfo": []
        },
        "Result": "completed",
        "Tasks": [
          {
            "Name": "prepareResource",
            "Progress": 1,
            "FinishTime": "2019-03-07 16:31:11",
            "SubTasks": []
          },
          {
            "Name": "deployESCluster",
            "Progress": 1,
            "FinishTime": "2019-03-07 16:34:32",
            "SubTasks": []
          },
          {
            "Name": "deployKibana",
            "Progress": 1,
            "FinishTime": "2019-03-07 16:35:13",
            "SubTasks": []
          },
          {
            "Name": "configLB",
            "Progress": 1,
            "FinishTime": "2019-03-07 16:35:15",
            "SubTasks": []
          }
        ],
        "Progress": 1
      }
    ],
    "RequestId": "870dd618-b1ae-40cc-a5a9-22b867367ed7"
  }
}

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Incorrect parameter.
ResourceInUse Resource is occupied.