CreateSecret - ApsaraDB RDS - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	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*****
RegionId	string	Yes	The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.	cn-hangzhou
Username	string	Yes	The username that is used to access the database.	user_jack
Password	string	Yes	The password that is used to access the database.	12345678
DbInstanceId	string	Yes	The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.	rm-sdfljk123***
ResourceGroupId	string	Yes	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***
DbNames	string	No	The name of the database.	users
Description	string	No	The description of the credential.	test
SecretName	string	No	The name of the credential.	Foo
Engine	string	Yes	The engine of the database. Note Only MySQL is supported.	MySQL

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	DF4961DD-16F5-5B24-BD4C-0C7788F7ADAF
SecretArn	string	The Alibaba Cloud Resource Name (ARN) of the credential for the created Data API account.	acs:rds:cn-hangzhou:1335786*:dbInstance/rm-bp1m7l3j63**
SecretName	string	The name of the credential.	Foo
Success	boolean	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 code	Error code	Error message	Description
400	InvalidParameters.Format	Specified parameters is not valid.	The values of some parameters are invalid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	The instance ID cannot be found.

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

Change history

Change time	Summary of changes	Operation
2024-01-22	The Error code has changed	View Change Details
2022-08-01	Add Operation	View Change Details