Data Management:GetProxy - Data Management - Alibaba Cloud - Data Management

Queries the details 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:GetProxy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProxyId	integer	Yes	The ID of the secure access proxy. You can call the ListProxies operation to query the proxy ID.	4**
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	F49D4598-2B3C-5723-865E-2CCB818E****
Success	boolean	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 condition cannot be empty!
ErrorCode	string	The error code returned if the request failed.	UnknownError
ProxyId	integer	The ID of the secure access proxy.	4**
CreatorId	integer	The ID of the user who enabled the secure access proxy feature.	12****
CreatorName	string	The nickname of the user who enabled the secure access proxy feature.	test_name
InstanceId	integer	The ID of the instance.	183****
PrivateEnable	boolean	Whether the internal endpoint is enabled. Default value: true.	true
PrivateHost	string	The internal endpoint.	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	Whether the public endpoint is enabled. Valid values: true: The public endpoint is enabled. false: The public endpoint is disabled.	true
PublicHost	string	The public endpoint. This value is returned regardless of whether the public endpoint is enabled. Note If the value of the PublicEnable parameter is true, a valid public endpoint that can be resolved by using Alibaba Cloud DNS is returned. If the value of the PublicEnable parameter is false, an invalid public endpoint that cannot be resolved by using Alibaba Cloud DNS is returned.	dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com
HttpsPort	integer	The HTTPS port number.	443
ProtocolType	string	The protocol type of the database. Example: MYSQL.	MYSQL
ProtocolPort	integer	The protocol port number.	3306
RegionId	string	The region ID of the instance.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "F49D4598-2B3C-5723-865E-2CCB818E****",
  "Success": true,
  "ErrorMessage": "The condition cannot be empty!",
  "ErrorCode": "UnknownError",
  "ProxyId": 0,
  "CreatorId": 0,
  "CreatorName": "test_name",
  "InstanceId": 0,
  "PrivateEnable": true,
  "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
  "PublicEnable": true,
  "PublicHost": "dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com",
  "HttpsPort": 443,
  "ProtocolType": "MYSQL",
  "ProtocolPort": 3306,
  "RegionId": "cn-hangzhou"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.