Create User Key - CreateAccessKey
Overview
Create User Key
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is CreateAccessKey . | 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 |
---|---|---|---|
UserName | string | Username | 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 |
AccessKey | AccessKey | Key Instance | No |
Data Model
AccessKey
Field Name | Type | Description Information | Required |
---|---|---|---|
AccessKeyID | string | User Public Key | No |
UserId | int | User ID | No |
AccessKeySecret | string | User Private Key | No |
Description | string | Key Remarks | No |
Status | string | Key Status | No |
CreatedAt | int | Key Creation Time | No |
ExpiredAt | int | Key Expiration Time | No |
UpdatedAt | int | Key Update Time | No |
DeletedAt | int | Key Deletion Time | No |
Example
Request Example
https://api.surfercloud.com/?Action=CreateAccessKey
&UserName=XZENszQt
Response Example
{
"AccessKey": {},
"Action": "CreateAccessKeyResponse",
"RetCode": 0
}