tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
SSL Certificates
    Documentation
    Download PDF

    DescribeCSR

    Last updated: 2023-12-01 16:21:29
    Download PDF

      1. API Description

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

      This API is used to query the details of a CSR.

      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: DescribeCSR.
      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.

      3. Output Parameters

      Parameter Name Type Description
      Id Integer The CSR ID.
      OwnerUin String The account.
      Domain String The domain.
      Organization String The organization name.
      Department String The department.
      Email String The email address.
      Province String The province.
      City String The city.
      Country String The country or region.
      EncryptAlgo String The key algorithm.
      KeyParameter String The algorithm parameter.
      Remarks String The remarks.
      Status Integer The status.
      KeyPassword String The password of the private key.
      Note: This field may return null, indicating that no valid values can be obtained.
      CreateTime String The creation time.
      CSR String The CSR content.
      Note: This field may return null, indicating that no valid values can be obtained.
      PrivateKey String The content of the private key.
      Note: This field may return null, indicating that no valid values can be obtained.
      RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

      4. Example

      Example1 Querying the information of a CSR

      This example shows you how to query the information of a CSR.

      Input Example

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

{
    "CSRId": 12344
}

      Output Example

      {
    "Response": {
        "Id": 12344,
        "OwnerUin": "123",
        "Domain": "zz.zz.cn",
        "Organization": "yunzhi",
        "Department": "Light",
        "Email": "171008474@qq.com",
        "Province": "Hunan",
        "City": "changsha",
        "Country": "CN",
        "EncryptAlgo": "RSA",
        "KeyParameter": "2048",
        "Remarks": "",
        "Status": 1,
        "KeyPassword": "123abcccaa",
        "CreateTime": "2023-08-25 09:48:47",
        "CSR": "-----BEGIN CERTIFICATE REQUEST-----\r\nMIICnjCCAYYCAQAwWTEWMBQGA1UEAwwNenouSGF0aGxpbS5jbjEPMA0GA1UECgwG\r\neXVuemhpMREwDwYDVQQHDAhjaGFuZ3NoYTEOMAwGA1UECAwFSHVuYW4xCzAJBgNV\r\nBAYTAkNOMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs8Wumn7cUG2d\r\n8ARiCg7rRtnNfonamdivha7bcm/xX4otKkI6f9TOjdO5TLQT2Qd55Iu8gVsGdFQ6\r\ntQwD/a3Koo2lD8XvBVI8R0LuGoK1jfChzglJo/FWwGyZjkMlUY6WisAk6utUYCSg\r\ncynZXDOkllEfwlkhsI4NbFG2ZrV7Ksj8Ed1e+Ki0GStVAb5j9qh/e4WeqE3IuZXG\r\ndofd/kEnvtprIasXgR+qpwwBTGpRwiqNhyP6z/xxM706eEhcnqh4oZi4abGCC2JM\r\nNJuVffFdmDiLaUKBrouk8WqZacB4nH1Uuk4y5eGGpxpX5UF+xgm/Sz0iI242dZFY\r\nDtqaSE8ZhwIDAQABoAAwDQYJKoZIhvcNAQEFBQADggEBAG8CES6epieMDaiXrEin\r\n2cVFxJUzrZf2aDm5YK4mAEz3h1kCQINDymtnQ4A4lFeQw+Le7xblS7qdMVT/5ecn\r\n64KbmfrThEaH/dTYOsbV7CipNfXiKH/SoD1Wz9bowNIxtXvy1t5Rlz3s8CBjKCKO\r\nj6vG+pUwh/mdAhpYlzh9VnfpMDAAtnBbxFhhLXqubiGe5YKqwuf3OwHov46g4+64\r\nPy8gmVbcqHy212Ea5wdOC+l54scm/b6bTdqo6Fv62bvepQI1mT5f198KTdKp1jCt\r\nw3gsfyY6WyL4zSvRgdbQyyWwys+rjsaNzqShSKxZ3xGKpdoOnK0uQX2RLfBB1nCi\r\nW9s=\r\n-----END CERTIFICATE REQUEST-----\r\n",
        "PrivateKey": null,
        "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.SystemError A system error occurred.
      InvalidParameter.InvalidCSRId Incorrect CSR ID.
      InvalidParameter.WithDetailReason The parameter is incorrect.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy