Domain name for API request: tcss.tencentcloudapi.com.
This API is used to query the list of servers.
A maximum of 20 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: DescribeAssetHostList. |
Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
Region | No | String | Common Params. This parameter is not required. |
Limit | No | Integer | Number of results to be returned. Default value: 10 . Maximum value: 100 . |
Offset | No | Integer | Offset. Default value: 0 . |
Filters.N | No | Array of AssetFilters | Filters.Status - String - Optional - Agent status. Values: ALL ; UNINSTALL (Not installed); OFFLINE , ONLINE . Default to All if it's not specified. HostName - String - Optional - Server nameGroup - String - Optional - Server group</li><li> HostIP - String - Optional - Server IP</li><li> HostID - String - Optional - Server IDDockerVersion - String - Optional - Docker versionMachineType - String - Optional - Server type. Values: ALL ; CVM (Cloud Virtual Machine); ECM (Edge Computing Machine); LH (Lighthouse), BM (Cloud Bare Metal); Other (non-Tencent Cloud server). Default to ALL if it's not specified.DockerStatus - String - Optional - Docker installation status. Values: ALL ; INSTALL (Installed); UNINSTALL (Not installed)ProjectID - String - Optional - Project IDTag:xxx(tag:key) - String - Optional - Tag key-value pair; Example: Filters":[{"Name":"tag:tke-kind","Values":["service"]}] |
By | No | String | Sorting field |
Order | No | String | Sorting order. Valid values: asc , desc . |
Parameter Name | Type | Description |
---|---|---|
List | Array of HostInfo | List of servers |
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. |
This example shows you how to query the list of servers.
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetHostList
<Common request parameters>
{}
{
"Response": {
"List": [
{
"HostID": "abc",
"HostIP": "abc",
"HostName": "abc",
"Group": "abc",
"DockerVersion": "abc",
"DockerFileSystemDriver": "abc",
"ImageCnt": 1,
"ContainerCnt": 1,
"Status": "abc",
"IsContainerd": true,
"MachineType": "abc",
"PublicIp": "abc",
"Uuid": "abc",
"InstanceID": "abc",
"RegionID": 0,
"Project": {
"ProjectName": "abc",
"ProjectID": 0
},
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"ClusterID": "abc"
}
],
"TotalCount": 1,
"RequestId": "abc"
}
}
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 |
---|---|
InternalError | An internal error occurred. |
InvalidParameter | The parameter is incorrect. |
InvalidParameter.ParsingError | A parameter parsing error occurred. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?