GetCertificateDetail - Certificate Management Service - Alibaba Cloud Documentation Center

Retrieves certificate details, excluding the certificate body and private key.

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
InstanceId	string	The ID of the instance.	cas_dv-cn-123
CommonName	string	The common name.	www.example.com
RequestId	string	The ID of the request.	5979d897-d69f-4fc9-87dd-f3bb73c40b80
Algorithm	string	The certificate algorithm. Valid values: RSA: The RSA algorithm. ECC: The ECC algorithm. SM2: The SM2 algorithm.	RSA
Domain	string	The domain names that are bound to the certificate. Multiple domain names are separated by commas (,).	aliyundoc.com,example.aliyundoc.com
CertificateId	integer	The certificate ID.	22559621
CertificateName	string	The certificate name.	123
CertIdentifier	string	The global ID of the certificate, which is used in various Alibaba Cloud services. The format of the ID is `<Certificate ID>-<Region ID>`. The region ID is `cn-hangzhou` for the China site and `ap-southeast-1` for the International site. For example, if a certificate ID is `123`, its `CertIdentifier` is `123-cn-hangzhou` for the China site and `123-ap-southeast-1` for the International site.	21912069-cn-hangzhou
CertificateSource	string	The source of the certificate. Valid values: BUY: a purchased certificate. TEST: a test certificate. Upload the certificate.	BUY
CertificateStatus	string	The status of the certificate. Valid values: issued: The certificate is issued. revoked: The certificate is revoked. willExpire: The certificate is about to expire. expired: The certificate has expired.	issued
NotBefore	integer	The beginning of the validity period of the certificate.	17321613180000
NotAfter	integer	The end of the validity period of the certificate.	17326613180000
CompanyId	integer	The ID of the company profile that is associated with the certificate application. This parameter is empty for DV certificates.	44211
ContactId	integer	The ID of the contact.	304066
KeySize	integer	The key size. For RSA algorithms, the key size is typically 2,048, 3,072, or 4,096 bits. For ECC and SM2 algorithms, the key size is typically 256 bits.	2048
SubjectAlternativeNames	array	The subject alternative names (SANs) of the certificate.
	string	An SAN.	aliyundoc.com
Serial	string	The serial number of the certificate.	123
ExistPrivateKey	boolean	Indicates whether a private key is available. Valid values: true false	true
UsingProductList	array	The list of cloud services in which the certificate is deployed.
	string	The cloud service.	CDN
FingerPrint	string	The fingerprint of the public key.	123
CertificateChainList	array<object>	The information about the certificate chain.
	object	The information about the certificate chain.
Issuer	string	The issuer of the certificate chain.	Digicert
Subject	string	The common name of the certificate chain.	Digicert
RemainDay	integer	The remaining validity period of the certificate chain.	10
NotBefore	integer	The beginning of the validity period.	17321613180000
NotAfter	integer	The end of the validity period.	17326613180000
Issuer	string	The issuer of the certificate.	Digicert
Tags	array<object>	The list of tags.
	object	The list of tags.
TagKey	string	The tag key of the instance. You can specify 1 to 20 tag keys. The value cannot be an empty string. The value can be up to 64 characters in length, cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	test
TagValue	string	The tag value.	test

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.