Bind PathX SSL Certificate - BindPathXSSL
Overview
Bind PathX SSL Certificate
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is BindPathXSSL . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project ID. Please refer to the GetProjectList interface. | Yes |
SSLId | string | Certificate ID, if no certificate ID is specified and no free certificate is applied for, HTTPS access cannot work properly. | Yes |
UGAId | string | UGA Instance ID | Yes |
Port.N | int | Binding SSL certificate to HTTPS port. Port.0 Port.1 corresponds to multiple Ports. If the Port does not exist, it will not be bound. | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=BindPathXSSL
&ProjectId=org-xxxxx
&SSLId=gssl-xxxx
&UGAId=uga-xxxxx
&Port.n=443
Response Example
{
"Action": "BindPathXSSLResponse",
"RetCode": 0
}