1. 接口描述
接口请求域名: ssl.tencentcloudapi.com 。
查询CSR详情
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeCSR。 |
| Version | 是 | String | 公共参数,本接口取值:2019-12-05。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| CSRId | 是 | Integer | CSR ID标识 示例值:17993 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | CSR Id标识 示例值:17993 |
| OwnerUin | String | 账号 示例值:100017155920 |
| Domain | String | 域名 示例值:www.***.com |
| Organization | String | 企业/单位名称 示例值:Tencent |
| Department | String | 部门 示例值:It |
| String | 邮箱 示例值:jjjj@qq.com |
|
| Province | String | 省份 示例值:Hunan |
| City | String | 城市 示例值:Changsha |
| Country | String | 国家 示例值:China |
| EncryptAlgo | String | 密钥算法 示例值:RSA |
| KeyParameter | String | 算法参数 示例值:2048 |
| Remarks | String | 备注 示例值:hellp |
| Status | Integer | 状态 示例值:1 |
| KeyPassword | String | 私钥密码 注意:此字段可能返回 null,表示取不到有效值。 示例值:password |
| CreateTime | String | 创建时间 示例值:2024-11-27 00:00:00 |
| CSR | String | CSR内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:csr content |
| PrivateKey | String | 私钥内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:----PrivateKey |
| SubjectAltName | Array of String | SAN域名 示例值:["zrhh.com"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询CSR
查询CSR
输入示例
POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCSR
<公共请求参数>
{
"CSRId": 12344
}
输出示例
{
"Response": {
"Id": 12344,
"OwnerUin": "6489626",
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 系统错误。 |
| InvalidParameter.InvalidCSRId | 错误的CSR ID。 |
| InvalidParameter.WithDetailReason | 参数有误。 |