DescribeSLInstance

Download PDF

Last updated: 2025-11-13 20:48:55

DescribeSLInstance

Last updated: 2025-11-13 20:48:55

Download PDF

1. API Description

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

This API is used to query the basic information of Serverless HBase instances.

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: DescribeSLInstance.
Version	Yes	String	Common Params. The value used for this API: 2019-01-03.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-nanjing, ap-shanghai, ap-singapore, eu-frankfurt.
InstanceId	Yes	String	Instance unique identifier (string).

3. Output Parameters

Parameter Name	Type	Description
InstanceId	String	Character string identifier of the instance.
InstanceName	String	Instance name.
PayMode	Integer	Instance billing mode. 0 indicates postpaid, i.e., pay-as-you-go; 1 indicates prepaid, i.e., monthly subscription.
DiskType	String	Instance storage type.
DiskSize	Integer	Instance single-node disk capacity, in GB.
NodeType	String	Instance node specifications.
ZoneSettings	Array of ZoneSetting	Detailed configuration of the instance AZ, including the AZ name, VPC information, and number of nodes.
Tags	Array of Tag	List of tags bound to the instance. Note: This field may return null, indicating that no valid values can be obtained.
ClusterId	Integer	Numeric identifier of the instance.
RegionId	Integer	Instance region ID.
Zone	String	Primary AZ of the instance.
ExpireTime	String	Instance expiration time. For post-paid instances, the API returns 0000-00-00 00:00:00.
IsolateTime	String	Instance isolation time. For instances that are not isolated, the API returns 0000-00-00 00:00:00.
CreateTime	String	Instance creation time.
Status	Integer	Instance status code: -2: "TERMINATED", 2: "RUNNING", 14: "TERMINATING", 19: "ISOLATING", 22: "ADJUSTING", and 201: "ISOLATED".
AutoRenewFlag	Integer	Auto-renewal flag. 0: notify before expiration but do not auto-renew; 1: notify before expiration and auto-renew; and 2: do not notify before expiration and do not auto-renew. If the business does not support renewal, the value is 0.
NodeNum	Integer	Total number of instance nodes.
SLInstance	Array of SLInstance
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 Serverless HBase Instance Information

This example shows you how to query Serverless HBase instance information.

Input Example

POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSLInstance
<Common request parameters>

{
    "InstanceId": "emr-3o9tms4i"
}

Output Example

{
    "Response": {
        "DiskSize": 100,
        "DiskType": "ESSD",
        "InstanceName": "sl-haoyuhua-test-create",
        "NodeType": "4C16G",
        "PayMode": 0,
        "RequestId": "a316989f-9316-4205-a2a3-64ab841aee14",
        "ZoneSettings": [
            {
                "NodeNum": 1,
                "VPCSettings": {
                    "SubnetId": "subnet-5bhc4kly",
                    "VpcId": "vpc-dcfhrh73"
                },
                "Zone": "ap-guangzhou-6"
            },
            {
                "NodeNum": 1,
                "VPCSettings": {
                    "SubnetId": "subnet-5bhc4kly",
                    "VpcId": "vpc-dcfhrh73"
                },
                "Zone": "ap-guangzhou-6"
            },
            {
                "NodeNum": 1,
                "VPCSettings": {
                    "SubnetId": "subnet-5bhc4kly",
                    "VpcId": "vpc-dcfhrh73"
                },
                "Zone": "ap-guangzhou-6"
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation	Operation failed.
FailedOperation.RefundCvmFailed	Operation failed.
InternalError	Internal error.
InternalError.CamCgwError	An error occurred while calling another service API.
InternalError.CvmError	An error occurred while calling another service API.
InvalidParameter	Invalid parameter.
InvalidParameter.InvalidAppId	Invalid `AppId`.
InvalidParameter.InvalidClusterId	Invalid parameter: ClusterId.
InvalidParameter.InvalidInstanceName	Invalid cluster name.
InvalidParameter.InvalidZone	Invalid AZ.
ResourceNotFound.InstanceNotFound	The instance was not found.
ResourceUnavailable.ResourceSpecNotExist	The resource specification does not exist.
UnauthorizedOperation.CheckCamAuth	Unauthorized operation.
UnsupportedOperation.ServiceNotSupport	This operation is not supported.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud