Domain name for API request: csip.intl.tencentcloudapi.com.
This API is used to create a cluster node list export task. The export fields include node ID, node name, public IP address, private IP address, node type, cores, client status, and running state. NodeType, ClientStatus, and RunStatus are internationalized. Filter filtering is supported, including ClientStatus memory filtering. Export is implemented through an async task. After JobId is returned, the frontend polls to query the export task status.
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: CreateClusterNodeListExportJob. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| ClusterCaMD5 | Yes | String | Cluster CA certificate MD5 (32-bit hexadecimal; unique ID) |
| MemberId.N | No | Array of String | Group account member id |
| Filter | No | Filter | List of Universal Filter Criteria. Supported filter fields: |
| ExportFields.N | No | Array of String | Export field list (all fields will be exported if not specified) |
| Parameter Name | Type | Description |
|---|---|---|
| JobId | String | Export task ID |
| 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: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateClusterNodeListExportJob
<Common request parameters>
{
"ClusterCaMD5": "a1b2c3d4e5f6789012345678901234ab",
"Filter": {
"Filters": [
{
"Name": "ClientStatus",
"Values": [
"ONLINE"
]
}
]
},
"ExportFields": [
"NodeId",
"NodeName",
"PublicIP",
"InternalIP",
"NodeType",
"CoresCount",
"ClientStatus",
"RunStatus"
]
}{
"Response": {
"JobId": "export-job-node-12345",
"RequestId": "5cd96106-1d72-466c-9bcf-9876543210ab"
}
}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 | Internal error. |
| InvalidParameter | Parameter error. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback