Bind Domain Names to Client CA Certificate for mTLS - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

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:SetClientCertificateHostnames

create

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID.	123456789****
Hostnames	array	Yes	The list of domain names to associate.
	string	No	The domain name.	www.example.com
Id	string	No	The client CA certificate ID.	babab9db65ee5efcca9f3d41d4b50d**

The Id parameter value must be the Id field value of each certificate record in the ListClientCaCertificates response, or the CACertificateId field value of each certificate record in the ListClientCertificates response, not the Id field. When associating domain names with an ESA CA certificate, you do not need to specify the certificate Id.

Response elements

Element	Type	Description	Example
	object	Schema of Response
SiteId	integer	The site ID.	123456789****
SiteName	string	The site name.	example.com
Id	string	The client CA certificate ID.	babab9db65ee5efcca9f3d41d4b50d**
Hostnames	array	The list of domain names to associate.
	string	The domain name.	www.example.com
RequestId	string	The request ID.	ET5BF670-09D5-4D0B-BEBY-D96A2A528000

Examples

Success response

JSON format

{
  "SiteId": 0,
  "SiteName": "example.com ",
  "Id": "babab9db65ee5efcca9f3d41d4b50d**",
  "Hostnames": [
    "www.example.com"
  ],
  "RequestId": "ET5BF670-09D5-4D0B-BEBY-D96A2A528000"
}

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	The specified parameter is invalid.	The specified parameter is invalid.
400	QuotaCheckFailed.Function	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.
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.
404	Certificate.NotFound	The specified certificate does not exist.	The specified certificate does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.