Query DNS Record Certificates via ListCertificatesByRecord API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries the list of site certificates that match records. Batch record matching is supported.

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

esa:ListCertificatesByRecord

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to query the site ID.	1234567890123
RecordName	string	Yes	The record name.	www.example.com
ValidOnly	boolean	No	Specifies whether to return only valid certificates.	true
Detail	boolean	No	Specifies whether to return certificate details.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	65C66B7B-671A-8297-9187-2R5477247B76
TotalCount	integer	The total number of entries, which is the same as the number of records.	12
SiteId	integer	The site ID.	1234567890123
SiteName	string	The site name.	example.com
Result	array<object>	The result array.
	array<object>	The result.
RecordName	string	The record name.	www.example.com
Count	integer	The number of certificates that match the record.	3
Certificates	array<object>	The list of certificates that match the record.
	object	The certificate information.
CasId	string	The ID of the Alibaba Cloud certificate.	30000137
Id	string	The ID of the certificate.	babab022c5e9b27bf9c64d7f4b1667f4
Name	string	The name of the certificate.	yourCertName
Region	string	The region where the certificate is stored.	cn-hangzhou
Status	string	The status of the certificate.	OK
Type	string	The type of the certificate. Valid values: Valid values: cas : An Alibaba Cloud certificate. upload : An uploaded custom certificate. keyless : A Keyless certificate. free : A free certificate.	free
CommonName	string	The common name of the certificate.	www.example.com
NotBefore	string	The date and time when the certificate becomes valid.	2023-02-28 06:17:11
NotAfter	string	The date and time when the certificate expires.	2024-02-28 06:17:11
Issuer	string	The issuer of the certificate.	GlobalSign nv-sa
IssuerCN	string	The common name of the certificate issuer.	GlobalSign Organization Validation CA - SHA256 - G3
SAN	string	The Subject Alternative Names (SANs) of the certificate.	www.example.com,*.example.com
SigAlg	string	The signature algorithm of the certificate.	SHA256-RSA
PubAlg	string	The public key algorithm of the certificate.	RSA
CreateTime	string	The time when the certificate was created.	2023-02-28 06:17:11
UpdateTime	string	The time when the certificate was last updated.	2023-02-28 06:17:11
SerialNumber	string	The serial number of the certificate.	baba39055622c008b90285a8838ed09a
FingerprintSha256	string	The SHA-256 fingerprint of the certificate.	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66
KeyServerId	string	The Keyless server ID. This parameter is valid only when `Type` is set to `keyless`.	baba39055622c008b90285a8838e****
ApplylingCount	integer	The number of certificates being applied for.	1
Status	string	The certificate configuration status of the record. Valid values: none: Not configured. configured: Configured. applying: Being applied for. failed: Application failed. Valid values: configured : Configured. applying : Being applied for. none : Not configured. failed : Application failed.	none

Examples

Success response

JSON format

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "TotalCount": 12,
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Result": [
    {
      "RecordName": "www.example.com ",
      "Count": 3,
      "Certificates": [
        {
          "CasId": "30000137",
          "Id": "babab022c5e9b27bf9c64d7f4b1667f4",
          "Name": "yourCertName",
          "Region": "cn-hangzhou",
          "Status": "OK",
          "Type": "free",
          "CommonName": "www.example.com ",
          "NotBefore": "2023-02-28 06:17:11",
          "NotAfter": "2024-02-28 06:17:11",
          "Issuer": "GlobalSign nv-sa",
          "IssuerCN": "GlobalSign Organization Validation CA - SHA256 - G3",
          "SAN": "www.example.com,*.example.com",
          "SigAlg": "SHA256-RSA",
          "PubAlg": "RSA",
          "CreateTime": "2023-02-28 06:17:11",
          "UpdateTime": "2023-02-28 06:17:11",
          "SerialNumber": "baba39055622c008b90285a8838ed09a",
          "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66",
          "KeyServerId": "baba39055622c008b90285a8838e****\n"
        }
      ],
      "ApplylingCount": 1,
      "Status": "none"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.SiteId	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.	Required parameter SiteId missing. Specify SiteId and try again.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	MissingParameter	Required parameter RecordName missing. Specify RecordName and try again.	Required parameter RecordName missing. Specify RecordName and try again.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	The authentication time parameter you entered is invalid. Check the parameter value and try again.
403	Unauthorized.InvalidToken	Token authentication failed.	The token you entered is invalid. Please check and enter the correct token and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.