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
Authorization information
There is currently no authorization information disclosed in the API.
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
Examples
Sample success responses
JSON
format
{
"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 |