Call GetUserCertificateDetail to retrieve certificate details - Certificate Management Service - Alibaba Cloud - Certificate Management Service

Retrieves the details of a certificate, including basic information and public/private key content. You can use this operation to download the certificate content and private key.

Operation description

The China single-user QPS limit for this operation is 100 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CertId	integer	Yes	The certificate ID. Note You can obtain this ID by calling ListUserCertificateOrder.	6055048
CertFilter	boolean	No	Specifies whether to filter certificate content. If set to true, the Cert, Key, EncryptCert, EncryptPrivateKey, SignCert, and SignPrivateKey fields are not returned. If set to false, these fields are returned. Default value: false.	false

Response elements

Element	Type	Description	Example
	object	The response object.
Cert	string	The certificate content that uses a non-Chinese cryptographic algorithm. This field is returned when the CertFilter parameter is set to false, and is not returned when set to true.	---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----
Key	string	The private key that uses a non-Chinese cryptographic algorithm. This field is returned when the CertFilter parameter is set to false, and is not returned when set to true.	-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----
EncryptCert	string	The encryption certificate content in PEM format that uses a Chinese cryptographic algorithm. This field is returned when the CertFilter parameter is set to false, and is not returned when set to true.	-----BEGIN CERTIFICATE----- MIICDzCCA*** -----END CERTIFICATE-----
EncryptPrivateKey	string	The private key of the encryption certificate in PEM format that uses a Chinese cryptographic algorithm. This field is returned when the CertFilter parameter is set to false, and is not returned when set to true.	-----BEGIN EC PRIVATE KEY----- MHcCAQEEI**** -----END EC PRIVATE KEY-----
SignCert	string	The signing certificate content in PEM format that uses a Chinese cryptographic algorithm. This field is returned when the CertFilter parameter is set to false, and is not returned when set to true.	-----BEGIN CERTIFICATE----- MIICDzCCAbagAw**** -----END CERTIFICATE-----
SignPrivateKey	string	The private key of the signing certificate in PEM format that uses a Chinese cryptographic algorithm. This field is returned when the CertFilter parameter is set to false, and is not returned when set to true.	-----BEGIN EC PRIVATE KEY----- MHcCAQEEILR**** -----END EC PRIVATE KEY-----
Id	integer	The certificate ID.	121345
Name	string	The certificate name.	cert_name
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each request, which can be used to troubleshoot issues.	15C66C7B-671A-4297-9187-2C4477247A74
Common	string	The primary domain name bound to the certificate.	*.com
Fingerprint	string	The certificate fingerprint.	1D7801BBE772D5DE55CBF1F88AEB41A42402DA07
Issuer	string	The certification authority.	Digicert
OrgName	string	The name of the company or organization to which the certificate purchaser belongs.	Alibaba
Province	string	The province where the company or organization of the certificate purchaser is located.	zhejiang
City	string	The city where the company or organization of the certificate purchaser is located.	hangzhou
Country	string	The country where the company or organization of the certificate purchaser is located.	CN
StartDate	string	The certificate issuance date in the format of YYYY-MM-DD.	2018-07-13
EndDate	string	The certificate expiration date in the format of YYYY-MM-DD.	2023-10-25
Sans	string	All domain names bound to the certificate.	*.com
Expired	boolean	Indicates whether the certificate has expired. Valid values: true: The certificate has expired. false: The certificate has not expired.	true
BuyInAliyun	boolean	Indicates whether the certificate was purchased from Alibaba Cloud. Valid values: true: Yes. false: No.	true
OrderId	integer	The ID of the certificate application order.	123456
ResourceGroupId	string	The resource group ID.	rg-aek****wia
Algorithm	string	The algorithm.	RSA
InstanceId	string	The resource instance ID.	cas-ivauto-hqito6
Sha2	string	The SHA-2 value of the certificate.	573415B23243066AD345AE5A57BD0FAE94F598BDD06D906278B5FF318F090FC8
SerialNo	string	The certificate serial number.	033cd852608689ef5e368fde89e0961769e8
CertIdentifier	string	The certificate ID appended with "-cn-hangzhou". For example, if the certificate ID is 123, the CertIdentifier is "123-cn-hangzhou".	13781326-cn-hangzhou
CertChain	array<object>	The certificate chain information.
	object	The certificate chain object.
IssuerCommonName	string	The common name of the issuer.	Encryption Everywhere DV TLS CA - G2
CommonName	string	The common name in the certificate chain.	test
NotAfter	integer	The end time of the certificate chain validity period.	17352613180000
NotBefore	integer	The start time of the certificate chain validity period.	17322633180000
RemainDay	integer	The remaining days of the certificate chain validity period.	1000
NotAfter	integer	The end time of the certificate validity period.	17326613180000
NotBefore	integer	The start time of the certificate validity period.	17321613180000
Tags	array<object>	The tag list.
	object	The resource tag.
TagKey	string	The tag key.	test
TagValue	string	The tag value.	test
CertSha2	string	The SHA-2 algorithm value of the certificate.	E696C2DB574DF99467A90BEF62B341294A9B0C731D228A0BD38265E1467D8EF0

Examples

Success response

JSON format

{
  "Cert": "---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----",
  "Key": "-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----",
  "EncryptCert": "-----BEGIN CERTIFICATE-----\nMIICDzCCA***\n-----END CERTIFICATE-----",
  "EncryptPrivateKey": "-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEI****\n-----END EC PRIVATE KEY-----",
  "SignCert": "-----BEGIN CERTIFICATE-----\nMIICDzCCAbagAw****\n-----END CERTIFICATE-----\n",
  "SignPrivateKey": "-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEILR****\n-----END EC PRIVATE KEY-----\n",
  "Id": 121345,
  "Name": "cert_name",
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Common": "*.com",
  "Fingerprint": "1D7801BBE772D5DE55CBF1F88AEB41A42402DA07",
  "Issuer": "Digicert",
  "OrgName": "Alibaba",
  "Province": "zhejiang",
  "City": "hangzhou",
  "Country": "CN",
  "StartDate": "2018-07-13",
  "EndDate": "2023-10-25",
  "Sans": "*.com",
  "Expired": true,
  "BuyInAliyun": true,
  "OrderId": 123456,
  "ResourceGroupId": "rg-aek****wia",
  "Algorithm": "RSA",
  "InstanceId": "cas-ivauto-hqito6",
  "Sha2": "573415B23243066AD345AE5A57BD0FAE94F598BDD06D906278B5FF318F090FC8",
  "SerialNo": "033cd852608689ef5e368fde89e0961769e8",
  "CertIdentifier": "13781326-cn-hangzhou",
  "CertChain": [
    {
      "IssuerCommonName": "Encryption Everywhere DV TLS CA - G2",
      "CommonName": "test",
      "NotAfter": 17352613180000,
      "NotBefore": 17322633180000,
      "RemainDay": 1000
    }
  ],
  "NotAfter": 17326613180000,
  "NotBefore": 17321613180000,
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "CertSha2": "E696C2DB574DF99467A90BEF62B341294A9B0C731D228A0BD38265E1467D8EF0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.