DescribeOfficialInstances

Last updated: 2025-12-07 00:27:11

DescribeOfficialInstances

Last updated: 2025-12-07 00:27:11

1. API Description

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

This API is used to query official cloud disk 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: DescribeOfficialInstances.
Version	Yes	String	Common Params. The value used for this API: 2021-07-12.
Region	No	String	Common Params. This parameter is not required for this API.
SuperAdminAccount	No	Boolean	Specifies whether to query the super admin account bound to the instance. default value is false.
InstanceIds.N	No	Array of String	Specifies one or more instance ids for querying, with a maximum of 100 per request.
PageNumber	No	Integer	Page number, int, used in conjunction with PageSize. default value is 1.
PageSize	No	Integer	Number of items per page, integer, used in conjunction with PageNumber. default value is 20. maximum value is 100.
OrderBy	No	String	Specifies the column to sort.
OrderByType	No	String	Sorting method.
AutoRenew	No	Integer	Specifies the filter type for renewal management.
BindPhone	No	Boolean	Specifies whether the super admin account is bound to a mobile number.

3. Output Parameters

Parameter Name	Type	Description
List	Array of Instance	Instance list
TotalCount	Integer	Total number.
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 an Official Instance

Input Example

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

{}

Output Example

{
    "Response": {
        "List": [
            {
                "InstanceId": "jexrwwoa",
                "Domain": "jexrwwoa.cofile.net",
                "EffectiveTime": "2021-11-17T03:03:45Z",
                "ExpireTime": "2021-12-17T23:59:59Z",
                "UserLimit": 5,
                "StorageLimit": "53687091200",
                "StorageLimitGB": 50,
                "Isolated": false,
                "AutoRenew": 1,
                "SuperAdminAccount": null
            }
        ],
        "TotalCount": 1,
        "RequestId": "27ec9933-ad39-46b0-9ea1-f863a89dd00c"
    }
}

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
InternalError	Internal error.
InvalidParameterValue.LimitExceeded	The number of parameter values or characters exceeds the limit.

Was this page helpful?

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

Yes

Feedback

tencent cloud