All Products
Search
Document Center

API Gateway:CreateSecret

Last Updated:Mar 26, 2026

Generates a key.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
apig:CreateSecretcreate
*All Resources
*
    none
none

Request syntax

POST /v1/secrets HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

namestringNo

The key name. It can be up to 64 characters in length and can contain letters, digits, and underscores (_).

my_secret
descriptionstringNo

The description of the key.

test
kmsConfigKMSConfigNo

The key configuration information of KMS.

gatewayTypestringNo

The type of the gateway.

API
secretSourcestringNo

The source of the key.

KMS
secretDatastringNo

The value of the KMS credential.

apikey-123456xxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

requestIdstring

ID of the request.

CFF809D7-045D-502F-BF6C-947Exxxxxxxx
codestring

The status code.

Ok
messagestring

The error message.

Failed to upload data. Please try again
dataobject

The returned data.

secretIdstring

The ID of the key.

sec-d5e6shmm1hkoxxxxxxxx

Examples

Sample success responses

JSONformat

{
  "requestId": "CFF809D7-045D-502F-BF6C-947Exxxxxxxx",
  "code": "Ok",
  "message": "Failed to upload data. Please try again",
  "data": {
    "secretId": "sec-d5e6shmm1hkoxxxxxxxx"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2026-01-07Add OperationView Change Details