Use DescribeCACertificate to query CA certificate details - Certificate Management Service - Alibaba Cloud - Certificate Management Service

Queries the details of a CA certificate.

Operation description

This operation queries the details of a root CA certificate or sub-CA certificate by using the unique identifier of the certificate. For example, you can query the serial number, subject information, and certificate content of a CA certificate.

Before you call this operation, you must have created a root CA certificate by calling CreateRootCACertificate and created a sub-CA certificate by calling CreateSubCACertificate.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation at a reasonable frequency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:DescribeCACertificate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Identifier	string	No	The unique identifier of the CA certificate that you want to query. Note You can call DescribeCACertificateList to query the unique identifiers of all CA certificates.	160ae6bb538d538c70c01f81dcf2****

Response elements

Element	Type	Description	Example
	object	DescribeCertificateResponse。
Certificate	object	The details of the CA certificate.
CertificateType	string	The type of the CA certificate. Valid values: ROOT: root CA certificate. SUB_ROOT: sub-CA certificate.	SUB_ROOT
X509Certificate	string	The content of the CA certificate.	-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----
Identifier	string	The unique identifier of the CA certificate.	160ae6bb538d538c70c01f81dcf2****
SerialNumber	string	The serial number of the CA certificate.	70e3b2566d92805173767869727fb92e****
SubjectDN	string	The subject attributes of the CA certificate, which include the following information: C: The country code of the organization. O: The name of the organization. OU: The department of the organization. L: The city where the organization is located. ST: The province or state where the organization is located. CN: The common name or abbreviation of the organization.	C=CN,O=aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonName	string	The common name or abbreviation of the organization associated with the CA certificate.	Aliyun
OrganizationUnit	string	The name of the department in the organization associated with the CA certificate.	Security
Organization	string	The name of the organization associated with the CA certificate.	aliyun
Locality	string	The city where the organization associated with the CA certificate is located.	Hangzhou
State	string	The province or state where the organization associated with the CA certificate is located.	Zhejiang
CountryCode	string	The country code of the organization associated with the CA certificate. For more information about country codes, see the International codes section in Manage company information.	CN
Sans	string	[Deprecated] This parameter is deprecated.	1
Status	string	The status of the CA certificate. Valid values: ISSUE: issued. REVOKE: revoked.	ISSUE
Algorithm	string	The encryption algorithm type of the CA certificate. Valid values: RSA: RSA algorithm. ECC: ECC algorithm. SM2: SM2 (Chinese national cryptographic) algorithm.	RSA
KeySize	integer	The key length of the CA certificate.	2048
SignAlgorithm	string	The signature algorithm of the CA certificate.	SHA256WITHRSA
BeforeDate	integer	The issuance date of the CA certificate. The value is a timestamp in milliseconds.	1634283958000
AfterDate	integer	The expiration date of the CA certificate. The value is a timestamp in milliseconds.	1665819958000
ParentIdentifier	string	The unique identifier of the root CA certificate that issued this CA certificate. Note This parameter is returned only when CertificateType is SUB_ROOT (sub-CA certificate).	1a83bcbb89e562885e40aa0108f5****
Sha2	string	The SHA-256 fingerprint of the CA certificate.	14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5	string	The MD5 fingerprint of the CA certificate.	160ae6bb538d538c70c01f81dcf2****
CrlStatus	string	The certificate revocation list (CRL) status (enabling status).	ACTIVE
CrlUrl	string	The CRL URL.	https://crl-cn-publish.oss-cn-hangzhou.aliyuncs.com/pca/crl/1925647866611395/1ed40789-483f-6023-b6b8-29ddd3bb0a9a.crl
CertTotalCount	integer	The total number of purchased certificate quotas.	40
CertRemainingCount	integer	The number of remaining certificate quotas available for allocation.	30
CertIssuedCount	integer	The number of certificates issued by the private CA instance.	10
CaCertChain	string	The complete certificate chain.	-----BEGIN CERTIFICATE----- -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
CrlDay	integer	The CRL validity period, ranging from 1 to 365 days.	90
IssuerType	string	The issuing CA authority. Valid values: local: private certificate. iTrusChina: compliant CA. external: externally imported.	local
Years	integer	The validity period of the CA certificate. Unit: years.	1
FullAlgorithm	string	The algorithm with key length.	RSA_2048
ResourceGroupId	string	The ID of the resource group to which the certificate belongs.	rg-aek2pxd7ekpoo2y
ClusterId	string	The identifier of the hardware security module (HSM) cluster. (The CA is enabled by using an HSM.)	XXX-id
KeyIndex	integer	The key index position in the HSM. (The CA is enabled by using an HSM.)	8
Tags	array<object>	The list of tags.
	object	The tag value.
TagKey	string	The tag key.	Usage status
TagValue	string	The tag value.	BMS
CertMaxTime	integer	The maximum validity period for certificates issued by the CA, specified by certMaxTime. Unit: days.	30
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
Years	integer	The validity period of the CA certificate. Unit: years.	10

Examples

Success response

JSON format

{
  "Certificate": {
    "CertificateType": "SUB_ROOT",
    "X509Certificate": "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----",
    "Identifier": "160ae6bb538d538c70c01f81dcf2****",
    "SerialNumber": "70e3b2566d92805173767869727fb92e****",
    "SubjectDN": "C=CN,O=aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
    "CommonName": "Aliyun",
    "OrganizationUnit": "Security",
    "Organization": "aliyun",
    "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-----END CERTIFICATE-----\n\n-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----\n\n-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
    "CrlDay": 90,
    "IssuerType": "local",
    "Years": 1,
    "FullAlgorithm": "RSA_2048",
    "ResourceGroupId": "rg-aek2pxd7ekpoo2y",
    "ClusterId": "XXX-id",
    "KeyIndex": 8,
    "Tags": [
      {
        "TagKey": "Usage status",
        "TagValue": "BMS"
      }
    ],
    "CertMaxTime": 30
  },
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Years": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.