DescribeVodDomainCertificateInfo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the certificate information about an accelerated domain name.

Operation description

This operation is available only in the China (Shanghai) region.

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
vod:DescribeVodDomainCertificateInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name.	example.com

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	5C1E43DC-9E51-4771-****-7D5ECEB547A1
CertInfos	array<object>	The certificate information.
CertInfo	object
CertExpireTime	string	The time at which the certificate expires. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-06-03T13:03:39Z
CertLife	string	The validity period of the certificate. Unit: months or years.	3 months
Status	string	The status of the certificate. success: The certificate is in effect. checking: The system is checking whether the domain name is added to ApsaraVideo VOD. cname_error: The domain name is not added to ApsaraVideo VOD. domain_invalid: The domain name contains invalid characters. unsupport_wildcard: The domain name is a wildcard domain name. Wildcard domain names are not supported. applying: The certificate application is in progress. failed: The certificate application failed. Note A value is returned for this parameter only when you set `CertType` to `free`. Otherwise, an empty value is returned for this parameter.	success
CertUpdateTime	string	The time at which the certificate was updated.	2023-04-26T20:23:38Z
CertDomainName	string	The domain name that matches the certificate.	example.com
ServerCertificateStatus	string	The status of the SSL certificate. on off	checking
CertOrg	string	The certificate authority (CA) that issued the certificate.	Let's Encrypt
DomainName	string	The accelerated domain name whose ICP filing status you want to update.	example.com
CertStartTime	string	The time when the certificate became effective.	2023-04-26T20:23:38Z
CertType	string	The type of the certificate. Valid values: free: a free certificate. cas: a certificate that is purchased from Certificate Management Service. upload: a user-uploaded certificate.	free
CertName	string	The certificate name.	cert-example.com
DomainCnameStatus	string	The CNAME status of the domain name. ok: The domain name points to the CNAME assigned by Alibaba Cloud CDN. cname_error: An error occurred and the domain name cannot point to the CNAME. op_domain_cname_error : An error occurred to the CNAME of the top-level domain. The domain name cannot point to the CNAME. unsupport_wildcard: The wildcard domain name is not supported.	ok
ServerCertificate	string	The public key of the certificate.	****
CertId	string	The ID of the certificate.	13227737-cn-hangzhou
CertRegion	string	The region where the certificate is used.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "5C1E43DC-9E51-4771-****-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "CertExpireTime": "2018-06-03T13:03:39Z",
        "CertLife": "3 months",
        "Status": "success",
        "CertUpdateTime": "2023-04-26T20:23:38Z",
        "CertDomainName": "example.com",
        "ServerCertificateStatus": "checking",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com",
        "CertStartTime": "2023-04-26T20:23:38Z",
        "CertType": "free",
        "CertName": "cert-example.com",
        "DomainCnameStatus": "ok",
        "ServerCertificate": "****",
        "CertId": "13227737-cn-hangzhou",
        "CertRegion": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-21	The response structure of the API has changed	View Change Details