Tencent Cloud

Download PDF

CreateHostExportJob

Last updated: 2024-07-22 11:00:58

Download PDF

1. API Description

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.

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: 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 name `Group - String - Optional - Server group</li><li>`HostIP `- String - Optional - Server IP</li><li>`HostID - String - Optional - Server ID `DockerVersion` - String - Optional - Docker version `MachineType` - 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 ID `Tag: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

3. Output Parameters

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.

4. Example

Example1 Exporting the list of servers

Input Example

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

{
    "ExportField": [
        "xxx"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "xx",
        "JobId": "xx"
    }
}

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

Tencent Cloud CLI 3.0

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	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.

tencent cloud

Recent Pages

CreateHostExportJob

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Exporting the list of servers

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

CreateHostExportJob

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Exporting the list of servers

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?