tencent cloud

Elasticsearch Service

User Guide
Release Notes and Announcements
Release Notes
Product Announcements
Security Announcement
Product Introduction
Overview
Elasticsearch Version Support Notes
Features
Elastic Stack (X-Pack)
Strengths
Scenarios
Capabilities and Restrictions
Related Concepts
Purchase Guide
Billing Overview
Pricing
Elasticsearch Service Serverless Pricing
Notes on Arrears
ES Kernel Enhancement
Kernel Release Notes
Targeted Routing Optimization
Compression Algorithm Optimization
FST Off-Heap Memory Optimization
Getting Started
Evaluation of Cluster Specification and Capacity Configuration
Creating Clusters
Accessing Clusters
ES Serverless Guide
Service Overview
Basic Concepts
5-Minute Quick Experience
Quick Start
Access Control
Writing Data
Data Query
Index Management
Alarm Management
ES API References
Related Issues
Data Application Guide
Data Application Overview
Data Management
Elasticsearch Guide
Managing Clusters
Access Control
Multi-AZ Cluster Deployment
Cluster Scaling
Cluster Configuration
Plugin Configuration
Monitoring and Alarming
Log Query
Data Backup
Upgrade
Practical Tutorial
Data Migration and Sync
Use Case Construction
Index Configuration
SQL Support
Receiving Watcher Alerts via WeCom Bot
API Documentation
History
Introduction
API Category
Instance APIs
Making API Requests
Data Types
Error Codes
FAQs
Product
ES Cluster
Service Level Agreement
Glossary
New Version Introduction
Elasticsearch Service July 2020 Release
Elasticsearch Service February 2020 Release
Elasticsearch Service December 2019 Release

DescribeInstanceOperations

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-11-13 20:48:24

1. API Description

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

This API is used to query the operation history of an instance by specified criteria.

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, 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 operation records
Operations Array of Operation Operation history
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the operation history of ES cluster instance

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": []
                    },
                    {
                        "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

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 Invalid parameter.
ResourceInUse Resource is in use.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック