All Products
Search
Document Center

Certificate Management Service:GetUserCertificateDetail

更新時間:Aug 07, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cert:GetUserCertificateDetailget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CertIdlongYes

The ID of the certificate.

Note You can call the ListUserCertificateOrder operation to query the ID.
6055048
CertFilterbooleanNo

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

ParameterTypeDescriptionExample
object

The response parameters.

Certstring

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-----
Keystring

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-----
EncryptCertstring

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-----
EncryptPrivateKeystring

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-----
SignCertstring

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-----
SignPrivateKeystring

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-----
Idlong

The ID of the certificate.

121345
Namestring

The name of the certificate.

cert_name
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

15C66C7B-671A-4297-9187-2C4477247A74
Commonstring

The primary domain name that is bound to the certificate.

*.com
Fingerprintstring

The fingerprint of the certificate.

1D7801BBE772D5DE55CBF1F88AEB41A42402DA07
Issuerstring

The certificate authority (CA) that issued the certificate.

Digicert
OrgNamestring

The name of the company or organization to which the certificate purchaser belongs.

Alibaba
Provincestring

The province of the company or organization to which the certificate purchaser belongs.

zhejiang
Citystring

The city of the company or organization to which the certificate purchaser belongs.

hangzhou
Countrystring

The country or region of the company or organization to which the certificate purchaser belongs.

CN
StartDatestring

The issuance date of the certificate.

2018-07-13
EndDatestring

The expiration date of the certificate.

2023-10-25
Sansstring

All domain names that are bound to the certificate.

*.com
Expiredboolean

Indicates whether the certificate has expired. Valid values:

  • true: yes
  • false: no
true
BuyInAliyunboolean

Indicates whether the certificate was purchased from Alibaba Cloud. Valid values:

  • true: yes
  • false: no
true
OrderIdlong

The order ID.

123456
ResourceGroupIdstring

The ID of the resource group.

rg-aek****wia
Algorithmstring

The algorithm.

RSA
InstanceIdstring

The instance ID.

cas-upload-50yf1q
Sha2string

The certificate sha2 value.

840707695D5EE41323102DDC2CB4924AA561012FBDC4E1A6324147119ED3C339
SerialNostring

The certificate serial No.

06ea4879591ddf84e6c8b6ba43607ccf

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"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-06The response structure of the API has changedView Change Details
2023-04-20The request parameters of the API has changed. The response structure of the API has changedView Change Details