DescribeVodSSLCertificateList - ApsaraVideo VOD - Alibaba Cloud Documentation Center

You can call this operation to query a list of certificates for a domain name.

Operation description

This operation is available only in the China (Shanghai) 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 support 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:DescribeVodSSLCertificateList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name.	example.com
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: an integer from 1 to 1000.	10
SearchKeyword	string	No	The keyword for a fuzzy query of certificate names.	certabc

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
CertificateListModel	object	The information about the certificate list.
Count	integer	The number of certificates.	2
CertList	object
Cert	array<object>	The list of certificates.
	object	The information about a certificate.
LastTime	integer	The time when the certificate was last modified. Unit: milliseconds.	1512388610
Fingerprint	string	The fingerprint of the certificate.	****
CertName	string	The name of the certificate.	video-ssl
Issuer	string	The certificate issuer.	****
CertId	integer	The ID of the certificate.	235437
Common	string	The Common Name (CN) property of the certificate. This is usually a domain name.	test
CertRegion	string	The region where the certificate is used. Supported values: cn-hangzhou and ap-southeast-1. Default value: cn-hangzhou.	cn-hangzhou
PageNumber	integer	The current page number. The value starts from 1. The default value is 1.	1
PageSize	integer	The number of entries per page. Valid values: an integer from 1 to 1000.	20

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "CertificateListModel": {
    "Count": 2,
    "CertList": {
      "Cert": [
        {
          "LastTime": 1512388610,
          "Fingerprint": "****",
          "CertName": "video-ssl",
          "Issuer": "****",
          "CertId": 235437,
          "Common": "test",
          "CertRegion": "cn-hangzhou"
        }
      ]
    },
    "PageNumber": 1,
    "PageSize": 20
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotFoundCertList	The certList is null.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.