GetClientCertificateHostnames - Edge Security Acceleration

Queries domain names associated with a client CA certificate. If no certificate is specified, domain names associated with an Edge Security Acceleration(ESA)-managed CA certificate are returned.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
esa:GetClientCertificateHostnames	get	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	Yes	The website ID.	1234567890123
Id	string	No	The certificate ID.	baba39055622c008b90285a8838ed09a

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
SiteId	long	The website ID.	1234567890123
SiteName	string	The website name.	example.com
Id	string	The ID of the client CA certificate.	baba39055622c008b90285a8838ed09a
Hostnames	array	The domain names with which the certificate is associated.
Hostnames	string	The domain name.	www.example.com
RequestId	string	The request ID.	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F

Examples

Sample success responses

JSONformat

{
  "SiteId": 1234567890123,
  "SiteName": "example.com\n",
  "Id": "baba39055622c008b90285a8838ed09a",
  "Hostnames": [
    "www.example.com "
  ],
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\n"
}

Error codes

HTTP status code	Error code	Error message	Description
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	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.
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.

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