All Products
Search
Document Center

ApsaraDB RDS:CreateSecret

Last Updated:Feb 29, 2024

Creates a credential for a user who uses the Data API feature.

Operation description

Supported database engines

  • MySQL

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

ETnLKlblzczshOTUbOCz*****
RegionIdstringYes

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

cn-hangzhou
UsernamestringYes

The username that is used to access the database.

user_jack
PasswordstringYes

The password that is used to access the database.

12345678
DbInstanceIdstringYes

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

rm-sdfljk123***
ResourceGroupIdstringYes

The ID of the resource group to which the instance belongs. You can call the DescribeDBInstanceAttribute operation to query the ID of the resource group.

rg-acfmxypivk***
DbNamesstringNo

The name of the database.

users
DescriptionstringNo

The description of the credential.

test
SecretNamestringNo

The name of the credential.

Foo
EnginestringYes

The engine of the database.

Note Only MySQL is supported.
MySQL

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF
SecretArnstring

The Alibaba Cloud Resource Name (ARN) of the credential for the created Data API account.

acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****
SecretNamestring

The name of the credential.

Foo
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF",
  "SecretArn": "acs:rds:cn-hangzhou:1335786***:dbInstance/rm-bp1m7l3j63****",
  "SecretName": "Foo",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameters.FormatSpecified parameters is not valid.The values of some parameters are invalid.
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.

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

Change history

Change timeSummary of changesOperation
2024-01-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
2022-08-01Add Operationsee changesets