CreateProxy - Data Management - Alibaba Cloud Documentation Center

Enables the secure access proxy feature for a database instance.

Operation description

The database instance runs the MySQL or MariaDB database engine. For example, the database instance can be an ApsaraDB RDS for MySQL instance, a PolarDB for MySQL cluster, a Distributed Relational Database Service (DRDS) cluster, or an AnalyticDB for MySQL cluster. The database instance can also be a self-managed MySQL or MariaDB database, or a MySQL or MariaDB database in a third-party cloud.
The database instance resides in the China (Hangzhou) or China (Beijing) region.
You are a Data Management (DMS) administrator, a database administrator (DBA), or the owner of the database instance.

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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
dms:CreateProxy	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	long	Yes	The ID of the database instance. You can call the ListInstances or GetInstance operation to query the database instance ID.	183****
Username	string	Yes	The username of the database account.	username
Password	string	Yes	The password of the database account.	******
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	4FFD154E-F57F-5374-B568-D6276F15****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned.	the instance proxy already exists.
ErrorCode	string	The error code returned.	InvalidParameterValid
ProxyId	long	The ID of the secure access proxy.	4**

Examples

Sample success responses

JSONformat

{
  "RequestId": "4FFD154E-F57F-5374-B568-D6276F15****",
  "Success": true,
  "ErrorMessage": "the instance proxy already exists.",
  "ErrorCode": "InvalidParameterValid",
  "ProxyId": 0
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-03-28	The internal configuration of the API is changed, but the call is not affected	View Change Details