Bind Custom Domain Name - BindBucketDomain
Overview
Bind Custom Domain Name
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is BindBucketDomain . | 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. Leave blank for the default project, sub-accounts must fill in. Please refer to the GetProjectList API | No |
BucketName | string | Custom domain name corresponding bucket name | Yes |
Domain | string | Custom Domain Name | 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 |
BucketName | string | Custom domain name corresponding bucket name | Yes |
BucketId | string | Custom domain name corresponding Bucket Id | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=BindBucketDomain
&ProjectId=yes
&BucketName=yes
&Domain=yes
Response Example
{
"Action": "BindBucketDomainResponse",
"BucketId": "no",
"BucketName": "no",
"RetCode": 0
}