DescribeInstances

Last updated: 2020-09-10 17:57:12

1. API Description

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

This API is used to get the list of CKafka instances under a user account.

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: ckafka.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeInstances.
Version Yes String Common parameter. The value used for this API: 2019-08-19.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId No String (Filter) filter by instance ID
SearchWord No String (Filter) filter by instance name. Fuzzy search is supported
Status.N No Array of Integer (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default
Offset No Integer Offset. If this parameter is left empty, 0 will be used by default
Limit No Integer Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 100.
TagKey No String Tag key match.

3. Output Parameters

Parameter Name Type Description
Result InstanceResponse Returned result
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting instance list

Input Example

https://ckafka.tencentcloudapi.com/?Action=DescribeInstances
&InstanceId=instance-will-s
&SearchWord=tre
&Offset=0&Limit=10
&Status.0=0
&Status.1=1
&Status.2=2
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "TotalCount": 1,
      "InstanceList": [
        {
          "InstanceId": "instance-will-s",
          "InstanceName": "treTest",
          "IfCommunity": true,
          "Status": 1
        }
      ]
    },
    "RequestId": "31740399-5d06-404b-a4b5-3652e21c8a1d"
  }
}

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 Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.RepetitionValue The parameter already exists.
InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation.BatchDelInstanceLimit The batch instance deletion limit is reached.
UnsupportedOperation.OssReject Oss rejected the operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help