tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeUserCluster

Last updated: 2024-12-06 15:48:50

    1. API Description

    Domain name for API request: tcss.intl.tencentcloudapi.com.

    This API is used to query the information of a cluster on the Security Dashboard and Cluster Security pages.

    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: DescribeUserCluster.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    Offset No Integer Offset
    Limit No Integer Maximum number of records per query
    Filters.N No Array of ComplianceFilters Name - String
    Name. Valid values: ClusterName, ClusterId, ClusterType, Region, ClusterCheckMode, ClusterAutoCheck.
    By No String Sorting field
    Order No String Sorting order. Valid values: asc, desc.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of clusters
    ClusterInfoList Array of ClusterInfoItem Cluster details
    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 查询用户集群列表

    查询用户集群列表

    Input Example

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

{
    "Limit": "2",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "ClusterInfoList": [
            {
                "CheckFailReason": "SUCCESS",
                "CheckStatus": "HasRisk",
                "ClusterAutoCheck": false,
                "ClusterCheckMode": "ClusterCheckMode",
                "ClusterId": "cls-abhq0j4o",
                "ClusterName": "bx_test_tmp",
                "ClusterNodeNum": 4,
                "ClusterOs": "centos",
                "ClusterStatus": "CSR_RUNNING",
                "ClusterType": "INDEPENDENT_CLUSTER",
                "ClusterVersion": "1.28.3",
                "DefenderErrorReason": "DefenderErrorReason",
                "DefenderStatus": "UnDefended",
                "HighRiskCount": 6,
                "HintRiskCount": 3,
                "MiddleRiskCount": 7,
                "Region": "ap-guangzhou",
                "SeriousRiskCount": 1,
                "TaskCreateTime": "2024-10-30 14:41:25",
                "UnreadyNodeNum": 3
            }
        ],
        "RequestId": "8a64a4f9-864c-49c6-adcb-21b483de477a",
        "TotalCount": 7
    }
}

    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
    AuthFailure A CAM signature/authentication error occurred.
    FailedOperation The operation failed.
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    UnauthorizedOperation The operation is unauthorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy