tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCSRSet

Last updated: 2024-07-30 17:12:09

    1. API Description

    Domain name for API request: ssl.tencentcloudapi.com.

    This API is used to query the CSR list.

    A maximum of 10 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: DescribeCSRSet.
    Version Yes String Common Params. The value used for this API: 2019-12-05.
    Region No String Common Params. This parameter is not required for this API.
    Limit No Integer The number of CSRs on each page. The default value is 10, and the maximum value is 100.
    Offset No Integer The pagination offset, starting from 0.
    Domain No String The domain for CSR filtering
    EncryptAlgo No String The encryption algorithm for CSR filtering

    3. Output Parameters

    Parameter Name Type Description
    Total Integer The total number of CSRs.
    Set Array of CSRItem The list of CSRs.
    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 Querying the CSR list

    This example shows you how to query the CSR list.

    Input Example

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

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

    Output Example

    {
    "Response": {
        "Total": 5,
        "Set": [
            {
                "Id": 123,
                "OwnerUin": "123",
                "Domain": "zz.Hathlim.cn",
                "Organization": "yunzhi",
                "Department": "Light",
                "Email": "171008474@qq.com",
                "Province": "Hunan",
                "City": "changsha",
                "Country": "CN",
                "EncryptAlgo": "RSA",
                "KeyParameter": "2048",
                "Remarks": "",
                "Status": 1,
                "CreateTime": "2023-08-25 09:48:47"
            },
            {
                "Id": 5555,
                "OwnerUin": "123",
                "Domain": "zz.Hathlim.cn",
                "Organization": "yunzhi",
                "Department": "Light",
                "Email": "171008474@qq.com",
                "Province": "Hunan",
                "City": "changsha",
                "Country": "CN",
                "EncryptAlgo": "RSA",
                "KeyParameter": "2048",
                "Remarks": "",
                "Status": 0,
                "CreateTime": "2023-08-25 09:43:59"
            }
        ],
        "RequestId": "f00f136b-c0c8-476a-8097-b1bdfc9d330f"
    }
}

    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.UnauthorizedOperation The operation is unauthorized.
    FailedOperation.CAMAuthorizedFail A CAM authentication error occurred.
    FailedOperation.SystemError A system error occurred.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy