GetCertificateDetail - Certificate Management Service - Alibaba Cloud Documentation Center

Queries the details of a certificate. The certificate content and private key content are not returned.

Operation description

The per-user queries per second (QPS) limit for this operation is 100. If this limit is exceeded, the API calls are throttled, which may affect your business. Use this operation as appropriate.

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:GetCertificateDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CertificateId	integer	Yes	The certificate ID.	18594156

Response elements

Element	Type	Description	Example
	object
Algorithm	string	The certificate algorithm. RSA: RSA algorithm. ECC: ECC algorithm. SM2: SM2 algorithm.	RSA
CertIdentifier	string	The global certificate ID in the format of certificate ID + "-" + site region ID. This ID is commonly used across Alibaba Cloud services. --For the China site, the value is certificate ID + "-cn-hangzhou". For the International site, the value is certificate ID + "-ap-southeast-1". For example, if the certificate ID is 123, the CertIdentifier on the China site is "123-cn-hangzhou", and the CertIdentifier on the International site is "123-ap-southeast-1".	21912069-cn-hangzhou
CertificateChainList	array<object>	The certificate chain information list.
	object	The certificate chain information.
Issuer	string	The issuer name of the certificate chain.	Digicert
NotAfter	integer	The end time of the certificate validity period.	17326613180000
NotBefore	integer	The start time of the certificate validity period.	17321613180000
RemainDay	integer	The remaining days of the certificate chain validity period.	10
Subject	string	The common name of the certificate chain.	Digicert
CertificateId	integer	The certificate ID.	22559621
CertificateName	string	The certificate name.	123
CertificateSource	string	The certificate source. BUY: Purchased certificate. TEST: Test certificate. UPLOAD: Uploaded certificate.	BUY
CertificateStatus	string	The certificate status. issued: Issued. revoked: Revoked. willExpire: About to expire. expired: Expired.	issued
CommonName	string	The common domain name.	www.example.com
CompanyId	integer	The company information ID associated with the certificate application. This value is empty for DV certificates.	44211
ContactId	integer	The contact ID.	304066
Csr	string	The certificate signing request (CSR) used to issue the certificate.	-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
DeploymentDesc	string	The deployment information in JSON format: --Scope: Valid values are all/server. The value is all if the certificate has a private key, or server if it does not. --ServerName: The name of the server associated with the certificate instance. --ResourceInstanceId: The resource identifier of the server associated with the certificate instance.	{ "Scope": "all", "ServerName": "acmeServerName", "ResourceInstanceId": "cas_dv-cn-XXX" }
Domain	string	All domain names included in the certificate. Multiple domain names are separated by commas (,).	aliyundoc.com,example.aliyundoc.com
ExistPrivateKey	boolean	Indicates whether a private key exists on the backend for the current certificate. Valid values: true false	true
FingerPrint	string	The public key fingerprint.	123
InstanceId	string	The instance ID.	cas_dv-cn-123
Issuer	string	The certificate issue authority.	Digicert
KeySize	integer	The key algorithm length. The RSA algorithm length is typically 2048, 3072, or 4096. The ECC and SM2 algorithm length is typically 256.	2048
NotAfter	integer	The end time of the certificate validity period.	17326613180000
NotBefore	integer	The start time of the certificate validity period.	17321613180000
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.	5979d897-d69f-4fc9-87dd-f3bb73c40b80
Serial	string	The certificate serial number.	123
SubjectAlternativeNames	array	The list of Subject Alternative Names (SANs) of the certificate, returned in array format. This corresponds to the `Subject Alternative Name` field of the certificate.
	string	The Subject Alternative Name (SAN) of the certificate.	aliyundoc.com
Tags	array<object>	The tag list.
	object	The tag list.
TagKey	string	The tag key of the instance. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	test
TagValue	string	The tag value.	test
UsingProductList	array	The list of Alibaba Cloud services to which the certificate is currently deployed.
	string	The Alibaba Cloud service.	CDN

Examples

Success response

JSON format

{
  "Algorithm": "RSA",
  "CertIdentifier": "21912069-cn-hangzhou",
  "CertificateChainList": [
    {
      "Issuer": "Digicert",
      "NotAfter": 17326613180000,
      "NotBefore": 17321613180000,
      "RemainDay": 10,
      "Subject": "Digicert"
    }
  ],
  "CertificateId": 22559621,
  "CertificateName": "123",
  "CertificateSource": "BUY",
  "CertificateStatus": "issued",
  "CommonName": "www.example.com",
  "CompanyId": 44211,
  "ContactId": 304066,
  "Csr": "-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----",
  "DeploymentDesc": "{\n      \"Scope\": \"all\",\n       \"ServerName\": \"acmeServerName\",\n       \"ResourceInstanceId\": \"cas_dv-cn-XXX\"\n}",
  "Domain": "aliyundoc.com,example.aliyundoc.com",
  "ExistPrivateKey": true,
  "FingerPrint": "123",
  "InstanceId": "cas_dv-cn-123",
  "Issuer": "Digicert",
  "KeySize": 2048,
  "NotAfter": 17326613180000,
  "NotBefore": 17321613180000,
  "RequestId": "5979d897-d69f-4fc9-87dd-f3bb73c40b80",
  "Serial": "123",
  "SubjectAlternativeNames": [
    "aliyundoc.com"
  ],
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "UsingProductList": [
    "CDN"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.