tencent cloud

Elasticsearch Service

DescribeInstanceOperations

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-10-13 13:26:46

1. API Description

Domain name for API request: es.intl.tencentcloudapi.com.

Query the operation records of an instance under specified conditions.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: DescribeInstanceOperations.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Cluster instance ID.
StartTime Yes String Start time, e.g., "2019-03-07 16:30:39"
EndTime Yes String End time, e.g., "2019-03-30 20:18:03"
Offset Yes Integer Paging Starting Value
Limit Yes Integer Pagination size.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of operation records
Operations Array of Operation Operation record
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.

4. Example

Example1 Querying ES Cluster Instance Operation Records

Query ES cluster instance operation records

Input Example

https://es.intl.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 parameters>

Output Example

{
    "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": [],
                        "ElapsedTime": 0
                    },
                    {
                        "Name": "deployESCluster",
                        "Progress": 1,
                        "FinishTime": "2019-03-07 16:34:32",
                        "SubTasks": [],
                        "ElapsedTime": 0
                    },
                    {
                        "Name": "deployKibana",
                        "Progress": 1,
                        "FinishTime": "2019-03-07 16:35:13",
                        "SubTasks": [],
                        "ElapsedTime": 0
                    },
                    {
                        "Name": "configLB",
                        "Progress": 1,
                        "FinishTime": "2019-03-07 16:35:15",
                        "SubTasks": [],
                        "ElapsedTime": 0
                    }
                ],
                "Progress": 1
            }
        ],
        "RequestId": "870dd618-b1ae-40cc-a5a9-22b867367ed7"
    }
}

5. Developer Resources

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 Internal error.
InvalidParameter.InvalidInstanceId Invalid InstanceId. No corresponding resources were found.
InvalidParameter.InvalidLimit The value of the pagination size Limit does not match the expectation.
InvalidParameter.InvalidTimeParam The value or format of a time-related parameter does not match the expected one.
ResourceNotFound.DBInfoNotFound Failed to obtain the database resource.
UnsupportedOperation.StatusNotSupport This operation is not supported. The instance status is incorrect.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백