Secure Custom Domains with SSL via SetDomainCertificate - API Gateway - Alibaba Cloud - API Gateway

Operation description

This operation is intended for API providers.
The SSL certificate must match the custom domain name.
After the SSL certificate is bound, HTTPS-based API services become available.

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

apigateway:SetDomainCertificate

update

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group. This ID is generated by the system and globally unique.	927d50c0f2e54b359919923d908bb015
DomainName	string	Yes	The custom domain name.	api.demo.com
CertificateName	string	Yes	The name of the SSL certificate.	test_cert
CertificateBody	string	No	The content of the certificate.	See the following request example. -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud .... -----END RSA PRIVATE KEY-----
CertificatePrivateKey	string	No	The private key of the SSL certificate.	See the following request example. -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud .... -----END RSA PRIVATE KEY-----
CaCertificateBody	string	No	The content of the CA certificate.	CAEncoded certificate content
SslVerifyDepth	string	No	The certificate verification depth.	2
SslOcspEnable	boolean	No	If enable ssl OCSP.	True
SslOcspCacheEnable	boolean	No	If enable ssl OCSP cache.	True
ClientCertSDnPassThrough	boolean	No	If pass ssl_client_s_dn of the cert to backend header 'X-Client-S-Dn'.	True

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	6EF60BEC-0242-43AF-BB20-270359FB54A7

Examples

Success response

JSON format

{
  "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.