Domain name for API request: tcss.tencentcloudapi.com.
This API is used to create a task to export 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: CreateHostExportJob. |
Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
Region | No | String | Common Params. This parameter is not required. |
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"]}] |
Limit | No | Integer | Offset. Default value: 0 . |
Offset | No | Integer | The number of results to return. Default value: 10. Maximum value: 10,000. |
By | No | String | Sorting field |
Order | No | String | Valid values: asc , desc . |
ExportField.N | No | Array of String | Export field |
Parameter Name | Type | Description |
---|---|---|
JobId | String | Export task ID, which is used to query the task progress on the frontend. |
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. |
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHostExportJob
<Common request parameters>
{
"ExportField": [
"xxx"
]
}
{
"Response": {
"RequestId": "xx",
"JobId": "xx"
}
}
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 |
---|---|
AuthFailure | A CAM signature/authentication error occurred. |
FailedOperation | The operation failed. |
InternalError | An internal error occurred. |
InvalidParameter | The parameter is incorrect. |
InvalidParameter.InvalidFormat | The parameter format is incorrect. |
InvalidParameter.MissingParameter | The required parameter is missing. |
InvalidParameter.ParsingError | A parameter parsing error occurred. |
InvalidParameterValue | The parameter value is incorrect. |
Was this page helpful?