All Products
Search
Document Center

Data Management:CreateProxy

Last Updated:May 25, 2023

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:CreateProxyRead
    All Resources
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdlongYes

The ID of the database instance. You can call the ListInstances or GetInstance operation to query the database instance ID.

183****
UsernamestringYes

The username of the database account.

username
PasswordstringYes

The password of the database account.

******
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

4FFD154E-F57F-5374-B568-D6276F15****
Successboolean

Indicates whether the request was successful. Valid values:

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

The error message returned.

ErrorCodestring

The error code returned.

InvalidParameterValid
ProxyIdlong

The ID of the secure access proxy.

4**

Examples

Sample success responses

JSONformat

{
  "RequestId": "4FFD154E-F57F-5374-B568-D6276F15****",
  "Success": true,
  "ErrorMessage": "",
  "ErrorCode": "InvalidParameterValid",
  "ProxyId": 0
}

Error codes

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