Call GetProxyAccess to query secure access proxy authorization - Data Management - Alibaba Cloud - Data Management

Queries authorization details for the secure access proxy feature.

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:GetProxyAccess

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProxyAccessId	integer	Yes	The unique ID generated by Data Management (DMS) when a user is authorized to use the secure access proxy feature for an instance. You can call the ListProxyAccesses operation to query this ID.	1
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	3CDB8601-AD74-4A47-8114-08E08CD6****
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 if the request failed.	The specified user not exists.
ErrorCode	string	The error code.	UserNotExist
ProxyAccess	object	The authorization information about the secure access proxy feature.
ProxyAccessId	integer	The unique ID generated by DMS when a user is authorized to use the secure access proxy feature for an instance. You can call the ListProxyAccesses operation to query this ID.	2002
GmtCreate	string	The time when the user was authorized to use the secure access proxy feature for the instance.	1643034647
AccessId	string	The username of the database account authorized to use the secure access proxy feature for the instance.	hObpgEXoca42q***
OriginInfo	string	The authorization method used to grant the user access to the secure access proxy feature. Valid values: Authorization by the Alibaba Cloud Account (): The value in the parentheses indicates the Alibaba Cloud account ID. Authorization by submitting the ticket (): The value in the parentheses indicates the ticket number submitted to request permissions.	Authorization by the Alibaba Cloud Account(29490401597700****)
IndepAccount	string	The username of the independent database account.	***
UserId	integer	The ID of the user.	12***
UserUid	string	The ID of the Alibaba Cloud account.	25936669186260****
UserName	string	The nickname of the user.	user
ProxyId	integer	The ID of the secure access proxy. Note You can call the ListProxies operation to query the ID of the secure access proxy.	1905
InstanceId	integer	The ID of the instance that has the secure access proxy feature enabled.	1922545

Examples

Success response

JSON format

{
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Success": true,
  "ErrorMessage": "The specified user not exists.",
  "ErrorCode": "UserNotExist",
  "ProxyAccess": {
    "ProxyAccessId": 2002,
    "GmtCreate": "1643034647",
    "AccessId": "hObpgEXoca42q***",
    "OriginInfo": "Authorization by the Alibaba Cloud Account(29490401597700****)",
    "IndepAccount": "***",
    "UserId": 0,
    "UserUid": "25936669186260****",
    "UserName": "user",
    "ProxyId": 1905,
    "InstanceId": 1922545
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.