tencent cloud

APIs

DescribeAutoAuthorizedRuleHost

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-10 17:06:25

1. API Description

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

This API is used to query the servers licensed according to an automatic licensing rule.

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: DescribeAutoAuthorizedRuleHost.
Version Yes String Common Params. The value used for this API: 2020-11-01.
Region No String Common Params. This parameter is not required.
RuleId Yes Integer Rule ID
Limit No Integer Number of results to be returned. Default value: all.
Offset No Integer Offset. Default value: 0.
Order No String Sorting field
By No String Sorting order. Valid values: asc, desc.

3. Output Parameters

Parameter Name Type Description
List Array of AutoAuthorizedRuleHostInfo List of servers licensed based on the automatic image licensing rule
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 Query information about hosts in the authorization scope by auto-authorization rules.

Input Example

https://tcss.intl.tencentcloudapi.com/?Action=DescribeAutoAuthorizedRuleHost
&RuleId=1
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "List": [
            {
                "ContainerCnt": 2,
                "DockerVersion": "19.03.9",
                "HostID": "8bc803fd-d85d-47b8-9e2b-9644674be677",
                "HostIP": "1.1.1.1",
                "HostName": "machine name",
                "ImageCnt": 1,
                "InstanceID": "ins-8bc803fd",
                "MachineType": "CVM",
                "PublicIp": "1.1.1.1",
                "Status": "ONLINE"
            }
        ],
        "RequestId": "8bc803fd-d85d-47b8-9e2b-9644674be677"
    }
}

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
AuthFailure A CAM signature/authentication error occurred.
FailedOperation.ErrRuleNotFind The rule is not found.
FailedOperation.RuleNotFind The rule is not found.
InternalError An internal error occurred.
InternalError.MainDBFail The database operation failed.
InvalidParameter The parameter is incorrect.
InvalidParameter.MissingParameter The required parameter is missing.
InvalidParameter.ParsingError A parameter parsing error occurred.
ResourceNotFound The resource does not exist.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백