tencent cloud

DescribeRegisterInstances
Last updated:2026-03-05 16:27:20
DescribeRegisterInstances
Last updated: 2026-03-05 16:27:20

1. API Description

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

This API is used to query managed instance information.

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: DescribeRegisterInstances.
Version Yes String Common Params. The value used for this API: 2020-10-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N No Array of String Managed instance id.

The maximum per request is 100.

Parameters must not be specified simultaneously InstanceIds and Filters.
Filters.N No Array of Filter Filter list. the maximum number of Filters is 10 per request, and the maximum number of Filter.Values is 5. parameters must not be specified simultaneously for InstanceIds and Filters.


- instance-name

Filter by [managed instance name].
Type: String.
Required: No

- instance-id

Filter by [managed instance ID].
Type: String.
Required: No

- register-status

Filter by [managed instance status]. valid values: Online
Offset No Integer Offset. default value: 0.
Limit No Integer Number of returned results, defaults to 20, maximum value is 100.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The total number of registration codes registered by the instance.
RegisterInstanceSet Array of RegisterInstanceInfo List of managed instance information.
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 Query Managed Instances Based on Filters

Query managed instances based on Filters.

Input Example

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

{
    "Filters": [
        {
            "Name": "instance-name",
            "Values": [
                "WebServer-01"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 1
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RegisterInstanceSet": [
            {
                "RegisterCodeId": "d0b7xxxx-a6xx-40x9-898x-44c9f508axxx",
                "InstanceId": "rins-uf673dgi",
                "InstanceName": "WebServer-01",
                "MachineId": "22c4dvvv-3ae9-4ff3-8331-d44147c96f8b",
                "SystemName": "Windows",
                "HostName": "webserver01",
                "LocalIp": "10.0.0.1",
                "PublicKey": "-----BEGIN RSA PUBLIC KEY-----\nAAAAAAAAAQEA1vVOon7U12dLFl7AOZjGnfWSMJ4rhHAagLne85Qbyn7rrow90bZF\ngsO9cpUfljliymtGAe1ZxkZZAWbwYeiS+x3KMO3rsbaXZtb9CiPSuMmyCcoyNRWy\nztLhIAHz6TFdoYYPdepY/HrL1rppGaVvUT6ufZrWIw2wF4KzPsIwGmfKYDrP+JOd\nfxkdewMwaFUP8xotqF+qi6YVbBMYSEGQyU9n42FTNxHMsLrBf1yPIcyaD+itWbWk\nyG0KcHTF2gbtgHqGV9wkc5jcqJYK3iJ1bQgEIWZ1lThRncOnHKHmSEnQ/XD5+6Hi\nLdVILVm0Gu8cnelE34kTcIqUAIQcB9wJBBBBBBBB\n-----END RSA PUBLIC KEY-----\n",
                "Status": "Online",
                "CreatedTime": "2020-09-22T08:00:00Z",
                "UpdatedTime": "2020-09-22T08:00:00Z"
            }
        ],
        "RequestId": "e28b9a8c-d7d3-4a12-bf8a-0123456789ab"
    }
}

Example2 Querying a Managed Instance by ID

Query a managed instance based on the managed instance ID.

Input Example

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

{
    "InstanceIds": [
        "rins-uf673dgi"
    ],
    "Offset": 0,
    "Limit": 1
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RegisterInstanceSet": [
            {
                "RegisterCodeId": "d0b7xxxx-a6xx-40x9-898x-44c9f508axxx",
                "InstanceId": "rins-uf673dgi",
                "InstanceName": "WebServer-01",
                "MachineId": "22c4dvvv-3ae9-4ff3-8331-d44147c96f8b",
                "SystemName": "Windows",
                "HostName": "webserver01",
                "LocalIp": "10.0.0.1",
                "PublicKey": "-----BEGIN RSA PUBLIC KEY-----\nAAAAAAAAAQEA1vVOon7U12dLFl7AOZjGnfWSMJ4rhHAagLne85Qbyn7rrow90bZF\ngsO9cpUfljliymtGAe1ZxkZZAWbwYeiS+x3KMO3rsbaXZtb9CiPSuMmyCcoyNRWy\nztLhIAHz6TFdoYYPdepY/HrL1rppGaVvUT6ufZrWIw2wF4KzPsIwGmfKYDrP+JOd\nfxkdewMwaFUP8xotqF+qi6YVbBMYSEGQyU9n42FTNxHMsLrBf1yPIcyaD+itWbWk\nyG0KcHTF2gbtgHqGV9wkc5jcqJYK3iJ1bQgEIWZ1lThRncOnHKHmSEnQ/XD5+6Hi\nLdVILVm0Gu8cnelE34kTcIqUAIQcB9wJBBBBBBBB\n-----END RSA PUBLIC KEY-----\n",
                "Status": "Online",
                "CreatedTime": "2020-09-22T08:00:00Z",
                "UpdatedTime": "2020-09-22T08:00:00Z"
            }
        ],
        "RequestId": "e28b9a8c-d7d3-4a12-bf8a-0123456789ab"
    }
}

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
InvalidParameterValue.InvalidFilter Invalid filter.
InvalidParameterValue.InvalidRegisterInstanceId Invalid managed instance ID.
ResourceNotFound.RoleNotFound The role does not exist.
UnauthorizedOperation.AssumeRoleUnauthorized Role play unauthorized.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback