全部产品
Search
文档中心

数据管理 DMS:CreateProxy - 开启数据安全访问

更新时间:Oct 21, 2024

调用CreateProxy接口,开启实例的数据安全访问功能。

接口说明

  • 实例的数据库类型为 MySQL 与 MariaDB,包括阿里云 RDS MySQL 引擎、PolarDB MySQL 引擎、PolarDB-X、AnalyticDB MySQL,也支持自建 MySQL 与 MariaDB 库、第三方云 MySQL 与 MariaDB 库。
  • 数据库实例所在地区为华东 1(杭州)、华北 2(北京)。
  • 您的用户角色是管理员角色、DBA 角色,或者是目标实例 Owner。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdlong

实例 ID,可通过调用接口 ListInstancesGetInstance 获取该参数的值。

183****
Usernamestring

数据库账号。

username
Passwordstring

数据库密码。

******
Tidlong

租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。

3***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrorMessagestring

错误信息。

实例代理已存在
ErrorCodestring

错误码。

InvalidParameterValid
ProxyIdlong

安全访问代理 ID。

4**

示例

正常返回示例

JSON格式

{
  "RequestId": "4FFD154E-F57F-5374-B568-D6276F15****",
  "Success": true,
  "ErrorMessage": "实例代理已存在",
  "ErrorCode": "InvalidParameterValid",
  "ProxyId": 0
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-28API 内部配置变更,不影响调用查看变更详情