DescribeVodDomainCertificateInfo-阿里云帮助中心

This operation queries the certificate information for a specified accelerated domain name.

Operation description

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

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

vod:DescribeVodDomainCertificateInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name added to ApsaraVideo for VOD.	example.com

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	5C1E43DC-9E51-4771-****-7D5ECEB547A1
CertInfos	object
CertInfo	array<object>	The certificate information.
	object
CertExpireTime	string	The time when the certificate expires. The time is in UTC and formatted as yyyy-MM-ddTHH:mm:ssZ.	2018-06-03T13:03:39Z
CertLife	string	The validity period of the certificate.	3 months
Status	string	The status of the certificate. success: The certificate is active. checking: The system is checking if the domain name has been added to ApsaraVideo for VOD. cname_error: The domain name is not mapped to the CNAME provided by ApsaraVideo for VOD. domain_invalid: The domain name contains invalid characters. unsupport_wildcard: Wildcard domains are not supported. applying: The certificate application is in progress. failed: The certificate application failed. Note This parameter is empty for other certificate types.	success
CertUpdateTime	string	The time when the certificate was last updated.	2023-04-26T20:23:38Z
CertDomainName	string	The domain name that matches the certificate.	example.com
ServerCertificateStatus	string	Indicates whether HTTPS is enabled for the domain. on: Enabled off: Disabled	on
CertOrg	string	The certificate authority (CA) that issued the certificate.	Let's Encrypt
DomainName	string	The accelerated domain name.	example.com
CertStartTime	string	The time when the certificate's validity begins.	2023-04-26T20:23:38Z
CertType	string	The type of the certificate. Valid values: free: free certificate cas: CAS certificate upload: A custom certificate that was uploaded	free
CertName	string	The name of the certificate.	cert-example.com
DomainCnameStatus	string	The CNAME status of the domain name: ok: The domain name is mapped to the CNAME provided by ApsaraVideo for VOD. cname_error: The domain name cannot be mapped to the CNAME. op_domain_cname_error: The domain name cannot be mapped because the CNAME of the root domain is invalid. unsupport_wildcard: Wildcard domains are not supported.	ok
ServerCertificate	string	The certificate public key.	****
CertId	string	The certificate ID.	13227737-cn-hangzhou
CertRegion	string	The service region where the certificate is used.	cn-hangzhou

Examples

Success response

JSON format

{
  "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": "on",
        "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.