文档

DescribeCACertificate - 查询单个根CA证书或子CA证书的详细信息

更新时间:

插件CA详情

接口说明

本接口用于通过证书的唯一识别码,查询单个根 CA 证书或子 CA 证书的详细信息,例如,CA 证书的序列号、使用者信息、证书内容等。

调用本接口前,您必须已经调用 CreateRootCACertificate 创建了根 CA 证书、调用 CreateSubCACertificate 创建了子 CA 证书。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cert:DescribeCACertificateget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Identifierstring

要查询的 CA 证书的唯一识别码。

说明 您可以调用 DescribeCACertificateList 查询所有 CA 证书的唯一识别码。
160ae6bb538d538c70c01f81dcf2****

返回参数

名称类型描述示例值
object

DescribeCertificateResponse

Certificateobject

CA 证书的详细信息。

CertificateTypestring

CA 证书的类型。取值:

  • ROOT:表示根 CA 证书。
  • SUB_ROOT:表示子 CA 证书。
SUB_ROOT
X509Certificatestring

CA 证书的内容。

-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----
Identifierstring

CA 证书的唯一识别码。

160ae6bb538d538c70c01f81dcf2****
SerialNumberstring

CA 证书的序列号。

70e3b2566d92805173767869727fb92e****
SubjectDNstring

CA 证书的使用者属性,包含以下信息:

  • C:组织机构所在国家代码。

  • O:组织机构的名称。

  • OU:组织机构下的部门。

  • L:组织机构所在城市。

  • ST:组织机构所在省份、直辖市或自治区。

  • CN:组织机构的通用名称或简称。

C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonNamestring

CA 证书关联的组织机构的通用名称或简称。

Aliyun
OrganizationUnitstring

CA 证书关联的组织机构下部门的名称。

Security
Organizationstring

CA 证书关联的组织机构的名称。

阿里云计算有限公司
Localitystring

CA 证书关联的组织机构所在城市的名称。

Hangzhou
Statestring

CA 证书关联的组织机构所在省份、直辖市或自治区的名称。

Zhejiang
CountryCodestring

CA 证书关联的组织机构所在国家的代码。

关于不同国家代码的含义,请参见管理公司信息中的国际代号章节。

CN
Sansstring

该参数已废弃。

1
Statusstring

CA 证书的状态。取值:

  • ISSUE:表示正常签发。
  • REVOKE:表示已被吊销。
ISSUE
Algorithmstring

CA 证书的加密算法类型。取值:

  • RSA:表示 RSA 算法。
  • ECC:表示 ECC 算法。
  • SM2:表示 SM2(国密)算法。
RSA
KeySizeinteger

CA 证书的密钥长度。

2048
SignAlgorithmstring

CA 证书的签名算法。

SHA256WITHRSA
BeforeDatelong

CA 证书的签发日期。使用时间戳表示,单位:毫秒。

1634283958000
AfterDatelong

CA 证书的到期日期。使用时间戳表示,单位:毫秒。

1665819958000
ParentIdentifierstring

签发该 CA 证书的根 CA 证书的唯一识别码。

说明 只有当 CertificateTypeSUB_ROOT(表示子 CA 证书)时,才会返回该参数。
1a83bcbb89e562885e40aa0108f5****
Sha2string

CA 证书的 SHA256 数字指纹。

14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5string

CA 证书的 MD5 数字指纹。

160ae6bb538d538c70c01f81dcf2****
CrlStatusstring

CRL 状态(启用状态)。

ACTIVE
CrlUrlstring

CRL 地址。

https://crl-cn-publish.oss-cn-hangzhou.aliyuncs.com/pca/crl/1925647866611395/1ed40789-483f-6023-b6b8-29ddd3bb0a9a.crl
CertTotalCountlong

已购买证书配额总数。

40
CertRemainingCountlong

剩余可分配证书配额数量。

30
CertIssuedCountlong

私有 CA 实例已经签发证书的数量。

10
CaCertChainstring

完整证书链。

-----BEGIN CERTIFICATE----- 用户证书 -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- 中间证书 -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- 根证书 -----END CERTIFICATE-----
CrlDayinteger

CRL 有效期 1-365 天。

90
RequestIdstring

本次请求的 ID。

15C66C7B-671A-4297-9187-2C4477247A74
Yearsinteger

CA 证书的有效期,单位:年。

10

示例

正常返回示例

JSON格式

{
  "Certificate": {
    "CertificateType": "SUB_ROOT",
    "X509Certificate": "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----",
    "Identifier": "160ae6bb538d538c70c01f81dcf2****",
    "SerialNumber": "70e3b2566d92805173767869727fb92e****",
    "SubjectDN": "C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
    "CommonName": "Aliyun",
    "OrganizationUnit": "Security",
    "Organization": "阿里云计算有限公司",
    "Locality": "Hangzhou",
    "State": "Zhejiang",
    "CountryCode": "CN",
    "Sans": "1",
    "Status": "ISSUE",
    "Algorithm": "RSA",
    "KeySize": 2048,
    "SignAlgorithm": "SHA256WITHRSA",
    "BeforeDate": 1634283958000,
    "AfterDate": 1665819958000,
    "ParentIdentifier": "1a83bcbb89e562885e40aa0108f5****",
    "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
    "Md5": "160ae6bb538d538c70c01f81dcf2****",
    "CrlStatus": "ACTIVE",
    "CrlUrl": "https://crl-cn-publish.oss-cn-hangzhou.aliyuncs.com/pca/crl/1925647866611395/1ed40789-483f-6023-b6b8-29ddd3bb0a9a.crl",
    "CertTotalCount": 40,
    "CertRemainingCount": 30,
    "CertIssuedCount": 10,
    "CaCertChain": "-----BEGIN CERTIFICATE-----\n用户证书\n-----END CERTIFICATE-----\n\n-----BEGIN CERTIFICATE-----\n中间证书\n-----END CERTIFICATE-----\n\n-----BEGIN CERTIFICATE-----\n根证书\n-----END CERTIFICATE-----",
    "CrlDay": 90
  },
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Years": 10
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-09OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情
2024-03-14OpenAPI 返回结构发生变更查看变更详情
2023-09-05OpenAPI 返回结构发生变更查看变更详情