调用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暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | long | 是 | 实例 ID,可通过调用接口 ListInstances 或 GetInstance 获取该参数的值。 | 183**** |
Username | string | 是 | 数据库账号。 | username |
Password | string | 是 | 数据库密码。 | ****** |
Tid | long | 否 | 租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。 | 3*** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4FFD154E-F57F-5374-B568-D6276F15****",
"Success": true,
"ErrorMessage": "实例代理已存在",
"ErrorCode": "InvalidParameterValid",
"ProxyId": 0
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-28 | API 内部配置变更,不影响调用 | 查看变更详情 |