tencent cloud

Feedback

ModifyCSR

Last updated: 2023-12-01 16:21:28

    1. API Description

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

    This API is used to modify the information of a CSR.

    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: ModifyCSR.
    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.
    CSRId Yes Integer The CSR ID.
    Generate Yes Boolean Whether to generate the CSR content. Once the CSR content is generated, the CSR record cannot be modified.
    Domain No String The domain.
    Organization No String The organization name.
    Department No String The department.
    Email No String The email address.
    Province No String The province.
    City No String The city.
    Country No String The country or region.
    EncryptAlgo No String The encryption algorithm. RSA and ECC are supported.
    KeyParameter No String The key pair parameter. For RSA, only the 2048-bit and 4096-bit key pairs are supported. For ECC, only prime256v1 is supported.
    Remark No String The remarks.
    KeyPassword No String The password of the private key.

    3. Output Parameters

    Parameter Name Type Description
    Id Integer The CSR ID.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying a CSR

    This example shows you how to modify a CSR.

    Input Example

    POST / HTTP/1.1
    Host: ssl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyCSR
    <Common request parameters>
    
    {
        "CSRId": 662,
        "Generate": false,
        "Domain": "abc123.com",
        "Organization": "abc123",
        "Department": "abc123",
        "Email": "abc@qq.com",
        "Province": "abc12",
        "City": "abc",
        "Country": "abc123",
        "EncryptAlgo": "RSA",
        "KeyParameter": "2048"
    }
    

    Output Example

    {
        "Response": {
            "Id": 662,
            "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
    FailedOperation Operation failed.
    FailedOperation.NetworkError The CA system is busy. Try again later.
    InvalidParameter.InvalidCSRId Incorrect CSR ID.
    InvalidParameter.WithDetailReason The parameter is incorrect.