调用CreateProxyAccess授权用户可以通过数据安全防护代理访问数据库实例。
- 实例已开启数据安全防护。
- 您的用户角色是管理员角色、DBA角色,或者是当前实例的数据安全防护责任人。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateProxyAccess |
系统规定参数。取值:CreateProxyAccess。 |
UserId | Long | 是 | 1 | |
ProxyId | Long | 是 | 1 |
安全防护代理ID。您可以调用ListProxies或GetProxy接口获取该参数。 |
IndepAccount | String | 否 | xxx |
数据库账号。 |
IndepPassword | String | 否 | xxx |
数据库密码。 |
Tid | Long | 否 | 1 |
租户ID。您可以调用GetUserActiveTenant或ListUserTenants接口获取该参数。 |
RegionId | String | 否 | cn-hangzhou |
选择DMS的服务地域。用于调用该接口,取值请参见RegionID参数说明。 说明 请根据应用所在地就近选择。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931 |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
ErrorMessage | String | UnknownError |
错误信息。 |
ErrorCode | String | 200 |
错误码。 |
ProxyAccessId | Long | 1 |
安全防护授权ID,当安全防护代理授权目标用户后,系统会自动生成一个安全防护授权ID,该ID全局唯一。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateProxyAccess
&UserId=1
&ProxyId=1
&IndepAccount=xxx
&IndepPassword=xxx
&Tid=1
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateProxyAccessResponse>
<RequestId>22A0495C-566D-5A90-A51A-7E737AD5980A</RequestId>
<ProxyAccessId>1</ProxyAccessId>
<Success>true</Success>
</CreateProxyAccessResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "22A0495C-566D-5A90-A51A-7E737AD5980A",
"ProxyAccessId" : 1,
"Success" : true
}
错误码
访问错误中心查看更多错误码。