All Products
Search

This Product

    Data Management:ListProxyAccesses

    Document Center

    Data Management:ListProxyAccesses

    Last Updated:Aug 28, 2026

    Queries the authorization list of a secure access proxy.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dms:ListProxyAccesses

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProxyId

    integer

    Yes

    The ID of the secure access proxy.

    Note

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

    47
    Tid

    integer

    No

    The ID of the tenant.

    Note

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

    3***

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The ID of the request.

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

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true
    ErrorMessage

    string

    The error message returned.

    ProxyId is mandatory for this action.
    ErrorCode

    string

    The error code returned.

    MissingProxyId
    ProxyAccessList

    array<object>

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

    object

    ProxyAccessId

    integer

    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

    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
    AccessId

    string

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

    MXPL8HalI22m****
    OriginInfo

    string

    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.

    责任人授权(29490401597700****)
    IndepAccount

    string

    The username of the independent database account.

    ****
    UserId

    integer

    The ID of the user.

    26****
    UserUid

    string

    The UID of the Alibaba Cloud account.

    25936669186260****
    UserName

    string

    The nickname of the user.

    user
    ProxyId

    integer

    The ID of the secure access proxy.

    47
    InstanceId

    integer

    The ID of the database instance.

    164****

    Examples

    Success response

    JSON format

    {
  "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": "责任人授权(29490401597700****)",
      "IndepAccount": "****",
      "UserId": 0,
      "UserUid": "25936669186260****",
      "UserName": "user",
      "ProxyId": 47,
      "InstanceId": 0
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.