Uploads an SSL certificate for a specified custom domain name.
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.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| 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. | For more information, see the following request examples |
| CertificatePrivateKey | string | No | The private key of the SSL certificate. | For more information, see the following request examples |
| CaCertificateBody | string | No | The content of the CA certificate. | Content of the CA certificate |
| 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 parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-14 | API Description Update | View Change Details |
| 2024-10-21 | The request parameters of the API has changed | View Change Details |
| 2024-02-19 | The internal configuration of the API is changed, but the call is not affected | View Change Details |