GetProxyAccess - Data Management - Alibaba Cloud Documentation Center

Queries the authorization information about 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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetProxyAccess	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProxyAccessId	long	Yes	The ID that Data Management (DMS) generates after the user is authorized to enable the secure access proxy feature for an instance. The ID is unique in DMS. You can call the ListProxyAccesses operation to query the ID.	1
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***

Response parameters

Parameter	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	long	The ID that DMS generates after the user is authorized to enable the secure access proxy feature for an instance. The ID is unique in DMS. You can call the ListProxyAccesses operation to query the ID.	2002
GmtCreate	string	The time when the user is authorized to enable the secure access proxy feature for an instance.	1643034647
AccessId	string	The username of the database account that is authorized to enable the secure access proxy feature for an instance.	hObpgEXoca42q***
OriginInfo	string	The method that is used to authorize the user to enable the secure access proxy feature for an instance. Valid values: Authorization by the Alibaba Cloud Account (): The information in the parentheses () indicates the ID 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\\\\)
IndepAccount	string	The username of the independent database account.	***
UserId	long	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	long	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	long	The ID of the instance for which the secure access proxy feature is enabled.	1922545

Examples

Sample success responses

JSONformat

{
  "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\\*\\*\\*\\*)\n",
    "IndepAccount": "***",
    "UserId": 0,
    "UserUid": "25936669186260****",
    "UserName": "user",
    "ProxyId": 1905,
    "InstanceId": 1922545
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history