Queries information about users that are authorized to access a database instance by using the secure access proxy feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListProxyAccesses

The operation that you want to perform. Set the value to ListProxyAccesses.

ProxyId Long Yes 47

The ID of the secure access proxy.

Note You can call the ListProxies operation to query the ID of the secure access proxy.
Tid Long No 3***

The ID of the tenant.

Note You can call the GetUserActiveTenant operation to query the ID of the tenant.
RegionId String No cn-hangzhou

The ID of the region in which DMS is activated. For more information, see RegionID parameter.

Note

Response parameters

Parameter Type Example Description
RequestId String E53D178A-85E9-5E1F-88B6-3CB1FCF2****

The ID of the request.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
ErrorMessage String ProxyId is mandatory for this action.

The error message returned.

ErrorCode String MissingProxyId

The error code returned.

ProxyAccessList Array of ProxyAccessList

The information about the users that are authorized to access the database instance by using the secure access proxy feature.

ProxyAccessId Long ****

The ID that DMS generates after the user is authorized to access the database instance by using the secure access proxy feature. The ID is unique in DMS.

GmtCreate String 2021-03-31 10:34:18

The time when the user is authorized to access the database instance by using the secure access proxy feature.

AccessId String MXPL8HalI22m****

The username of the database account that is authorized to access the database instance by using the secure access proxy feature.

OriginInfo String Authorization by the Alibaba Cloud account (29490401597700****)

The method that is used to authorize the user to access the database instance by using the secure access proxy feature. Valid values:

  • Authorization by the Alibaba Cloud Account (): The information in the parentheses () indicates the user ID (UID) of the Alibaba Cloud account.
  • Authorization by submitting the ticket ():The information in the parentheses () indicates the number of the ticket that the user submits to apply for permissions.
IndepAccount String ****

The username of the independent database account.

UserId Long 26****

The ID of the user.

UserUid String 25936669186260****

The UID of the Alibaba Cloud account.

UserName String user

The nickname of the user.

ProxyId Long 47

The ID of the secure access proxy.

InstanceId Long 164****

The ID of the database instance.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ListProxyAccesses
&ProxyId=47
&Tid=3***
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListProxyAccessesResponse>
    <RequestId>E53D178A-85E9-5E1F-88B6-3CB1FCF2****</RequestId>
    <Success>true</Success>
    <ProxyAccessList>
        <GmtCreate>2021-03-31 10:34:18</GmtCreate>
        <UserName>user</UserName>
        <AccessId>MXPL8HalI22m****</AccessId>
        <InstanceId>164****</InstanceId>
        <UserId>26****</UserId>
        <UserUid>25936669186260****</UserUid>
        <ProxyId>47</ProxyId>
        <ProxyAccessId>**</ProxyAccessId>
        <OriginInfo>Authorization by the Alibaba Cloud account (29490401597700****)</OriginInfo>
    </ProxyAccessList>
    <ProxyAccessList>
        <GmtCreate>2021-03-30 10:44:15</GmtCreate>
        <UserName>user1</UserName>
        <AccessId>8t1RshbwmWOQ****</AccessId>
        <InstanceId>164****</InstanceId>
        <UserId>47****</UserId>
        <UserUid>188097248834****</UserUid>
        <ProxyId>47</ProxyId>
        <ProxyAccessId>**</ProxyAccessId>
        <OriginInfo>Authorization by the Alibaba Cloud account (29490401597700****)</OriginInfo>
    </ProxyAccessList>
</ListProxyAccessesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E53D178A-85E9-5E1F-88B6-3CB1FCF2****",
  "Success" : true,
  "ProxyAccessList" : [ {
    "GmtCreate" : "2021-03-31 10:34:18",
    "UserName" : "user",
    "AccessId" : "MXPL8HalI22m****",
    "InstanceId" : "164****",
    "UserId" : "26****",
    "UserUid" : "25936669186260****",
    "ProxyId" : 47,
    "ProxyAccessId" : "**",
    "OriginInfo" : "Authorization by the Alibaba Cloud account (29490401597700****)"
  }, {
    "GmtCreate" : "2021-03-30 10:44:15",
    "UserName" : "user1",
    "AccessId" : "8t1RshbwmWOQ****",
    "InstanceId" : "164****",
    "UserId" : "47****",
    "UserUid" : "188097248834****",
    "ProxyId" : 47,
    "ProxyAccessId" : "**",
    "OriginInfo" : "Authorization by the Alibaba Cloud account (29490401597700****)"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.