tencent cloud

APIs

DocumentaçãoAPIsCloud Security CenterContainer Asset Management APIsCreateClusterNodeListExportJob

CreateClusterNodeListExportJob

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 10:19:41

1. API Description

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.

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: 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)
Input limitation: length must equal 32 characters
MemberId.N No Array of String

Group account member id
Filter No Filter

List of Universal Filter Criteria. Supported filter fields:
NodeName: node name, fuzzy matching.
NodeId: node ID, exact matching.
NodeUniqueID: node unique ID, exact matching (NodeAssetID is an equivalent alias).
NodeType: node type, exact matching. Values: SUPER (super node), MASTER (primary node), WORKER (work node).
RunStatus: node running status, exact matching.
InternalIP: private IP address, exact matching.
ClientStatus: client status, exact matching. Values: ONLINE (online), OFFLINE (offline), UNINSTALL (not installed).
ExportFields.N No Array of String

Export field list (all fields will be exported if not specified)
Enumeration values:
NodeId: node ID
NodeName: node name
PublicIP: public IP address
InternalIP: private IP address
NodeType: node type (NORMAL common node / SUPER Super Node / WORKER / MASTER / ETCD)
CoresCount: core count
ClientStatus: client status (ONLINE online / OFFLINE offline / UNINSTALL not installed)
RunStatus: running state (Running running / Exception exception)

3. Output Parameters

Parameter Name Type Description
JobId String

Export task ID
Parameter value for reference: used when polling the export task status 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 Example of creating a cluster node list export task

Input Example

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"
    ]
}

Output Example

{
    "Response": {
        "JobId": "export-job-node-12345",
        "RequestId": "5cd96106-1d72-466c-9bcf-9876543210ab"
    }
}

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
InternalError Internal error.
InvalidParameter Parameter error.
Anterior: CreateClusterNamespaceListExportJobPróximo: CreatePodContainerListExportJob

Ajuda e Suporte

Esta página foi útil?

comentários