All Products
Search
Document Center

Data Management:ListProxyAccesses

Last Updated:Oct 21, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProxyIdlongYes

The ID of the secure access proxy.

Note You can call the ListProxies operation to query the ID of the secure access proxy.
47
TidlongNo

The ID of the tenant.

Note You can call the GetUserActiveTenant operation to query the ID of the tenant.
3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

E53D178A-85E9-5E1F-88B6-3CB1FCF2****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
ErrorMessagestring

The error message returned.

ProxyId is mandatory for this action.
ErrorCodestring

The error code returned.

MissingProxyId
ProxyAccessListarray<object>

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

ProxyAccessListobject
ProxyAccessIdlong

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.

****
GmtCreatestring

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

2021-03-31 10:34:18
AccessIdstring

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

MXPL8HalI22m****
OriginInfostring

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.
Authorization by the Alibaba Cloud Account(29490401597700****)
IndepAccountstring

The username of the independent database account.

****
UserIdlong

The ID of the user.

26****
UserUidstring

The UID of the Alibaba Cloud account.

25936669186260****
UserNamestring

The nickname of the user.

user
ProxyIdlong

The ID of the secure access proxy.

47
InstanceIdlong

The ID of the database instance.

164****

Examples

Sample success responses

JSONformat

{
  "RequestId": "E53D178A-85E9-5E1F-88B6-3CB1FCF2****",
  "Success": true,
  "ErrorMessage": "ProxyId is mandatory for this action.",
  "ErrorCode": "MissingProxyId",
  "ProxyAccessList": [
    {
      "ProxyAccessId": 0,
      "GmtCreate": "2021-03-31 10:34:18",
      "AccessId": "MXPL8HalI22m****",
      "OriginInfo": "Authorization by the Alibaba Cloud Account(29490401597700****)",
      "IndepAccount": "****",
      "UserId": 0,
      "UserUid": "25936669186260****",
      "UserName": "user",
      "ProxyId": 47,
      "InstanceId": 0
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history