GetUserCertificateDetail - Certificate Management Service

Queries the details of a certificate.

Operation description

You can call this operation up to 100 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cert:GetUserCertificateDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CertId	long	Yes	The ID of the certificate. Note You can call the ListUserCertificateOrder operation to query the ID.	6055048
CertFilter	boolean	No	Specifies whether to filter return results. Valid values: true and false. Default value: false. true specifies that the Cert, Key, EncryptCert, EncryptPrivateKey, SignCert, and SignPrivateKey parameters are not returned. false specifies that the parameters are returned.	false

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Cert	string	The content of the certificate if the certificate does not use an SM algorithm. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.	---BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----
Key	string	The private key of the certificate if the certificate does not use an SM algorithm. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.	-----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----
EncryptCert	string	The content of the encryption certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.	-----BEGIN CERTIFICATE----- MIICDzCCA*** -----END CERTIFICATE-----
EncryptPrivateKey	string	The private key of the encryption certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.	-----BEGIN EC PRIVATE KEY----- MHcCAQEEI**** -----END EC PRIVATE KEY-----
SignCert	string	The content of the signing certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.	-----BEGIN CERTIFICATE----- MIICDzCCAbagAw**** -----END CERTIFICATE-----
SignPrivateKey	string	The private key of the signing certificate if the certificate uses an SM algorithm and is encoded in the PEM format. If certFilter is set to false, this parameter is returned. Otherwise, this parameter is not returned.	-----BEGIN EC PRIVATE KEY----- MHcCAQEEILR**** -----END EC PRIVATE KEY-----
Id	long	The ID of the certificate.	121345
Name	string	The name of the certificate.	cert_name
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	15C66C7B-671A-4297-9187-2C4477247A74
Common	string	The primary domain name that is bound to the certificate.	*.com
Fingerprint	string	The fingerprint of the certificate.	1D7801BBE772D5DE55CBF1F88AEB41A42402DA07
Issuer	string	The certificate authority (CA) that issued the certificate.	Digicert
OrgName	string	The name of the company or organization to which the certificate purchaser belongs.	Alibaba
Province	string	The province of the company or organization to which the certificate purchaser belongs.	zhejiang
City	string	The city of the company or organization to which the certificate purchaser belongs.	hangzhou
Country	string	The country or region of the company or organization to which the certificate purchaser belongs.	CN
StartDate	string	The issuance date of the certificate.	2018-07-13
EndDate	string	The expiration date of the certificate.	2023-10-25
Sans	string	All domain names that are bound to the certificate.	*.com
Expired	boolean	Indicates whether the certificate has expired. Valid values: true: yes false: no	true
BuyInAliyun	boolean	Indicates whether the certificate was purchased from Alibaba Cloud. Valid values: true: yes false: no	true
OrderId	long	The order ID.	123456
ResourceGroupId	string	The ID of the resource group.	rg-aek****wia
Algorithm	string	The algorithm.	RSA
InstanceId	string	The instance ID of the resource.	cas-upload-50yf1q
Sha2	string	The SHA-2 value of the certificate.	840707695D5EE41323102DDC2CB4924AA561012FBDC4E1A6324147119ED3C339
SerialNo	string	The serial number of the certificate.	06ea4879591ddf84e6c8b6ba43607ccf
CertIdentifier	string	The unique identifier of the certificate. The value of this parameter must be in the {Certificate ID}-cn-hangzhou format.	10741304-cn-hangzhou
CertChain	array<object>	The certificate chain.
CertChain	object	The certificate chain object.
IssuerCommonName	string	The common name of the issuer.	Encryption Everywhere DV TLS CA - G2
CommonName	string	The common name of the certificate.	test
NotAfter	long	The end of the validity period of the certificate.	17322613180000
NotBefore	long	The beginning of the validity period of the certificate.	17322633180000
RemainDay	integer	The remaining days of the certificate validity period.	1000

Examples

Sample success responses

JSONformat

{
  "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-upload-50yf1q",
  "Sha2": "840707695D5EE41323102DDC2CB4924AA561012FBDC4E1A6324147119ED3C339",
  "SerialNo": "06ea4879591ddf84e6c8b6ba43607ccf",
  "CertIdentifier": "10741304-cn-hangzhou",
  "CertChain": [
    {
      "IssuerCommonName": "Encryption Everywhere DV TLS CA - G2",
      "CommonName": "test",
      "NotAfter": 17322613180000,
      "NotBefore": 17322633180000,
      "RemainDay": 1000
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-22	The response structure of the API has changed	View Change Details
2024-09-23	The response structure of the API has changed	View Change Details
2024-08-06	The response structure of the API has changed	View Change Details
2023-04-20	The request parameters of the API has changed. The response structure of the API has changed	View Change Details