Domain name for API request: tcr.tencentcloudapi.com.
This API is used to query the instance information.
A maximum of 100 requests can be initiated per second for this API.
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: DescribeInstances. |
Version | Yes | String | Common Params. The value used for this API: 2019-09-24. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
Registryids.N | No | Array of String | List of instance IDs (if it is empty, it indicates to get all instances under the current account) |
Offset | No | Integer | Offset. Default value: 0. |
Limit | No | Integer | Maximum number of output entries. Default value: 20. Maximum value: 100. |
Filters.N | No | Array of Filter | Filters |
AllRegion | No | Boolean | Whether to get the instances in all regions. Default value: False. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Total number of instances |
Registries | Array of Registry | List of instances Note: This field may return null, indicating that no valid values can be obtained. |
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. |
https://tcr.tencentcloudapi.com/?Action=DescribeInstances
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"Registries": [
{
"RegistryId": "cls-xxxxxxx",
"RegistryName": "aaa",
"Status": "Running",
"RegistryType": "standard",
"PublicDomain": "mytest.tencentcloudcr.com",
"InternalEndpoint": "8.9.10.9",
"ExpiredAt": "2020-09-10",
"PayMod": 1,
"RenewFlag": 1
}
],
"RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 |
InternalError | Internal error. Please check and try again. |
InternalError.DbError | Database error. Please check and try again. |
InvalidParameter | Parameter error. Please check and try again. |
MissingParameter | Missing parameters. Please check and try again. |
OperationDenied | Operation denied. |
ResourceInsufficient.ErrorInstanceNotRunning | Exceptional instance status. |
UnauthorizedOperation | The operation is unauthorized. |
UnknownParameter | Unknown parameter error. Please check and try again. |
UnsupportedOperation | Unsupported operation |
문제 해결에 도움이 되었나요?