ListProxies - Query secure access proxies - Data Management

Queries proxies generated by 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:ListProxies

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The tenant ID. Call the GetUserActiveTenant operation to query this value.	3***

Response elements

Element	Type	Description	Example
	object	The response structure.
RequestId	string	The request ID.	5812180E-555F-5F90-BE4F-280576F4****
Success	boolean	Whether the request succeeded. Valid values: true false	true
ErrorMessage	string	The error message.	User can not access to Tenant [123445]
ErrorCode	string	The error code.	UnknownError
ProxyList	array<object>	The list of secure access proxies.
	object	A secure access proxy entry.
ProxyId	integer	The proxy ID.	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 instance ID.	183****
PrivateEnable	boolean	Whether the internal endpoint is enabled. Default: true.	true
PrivateHost	string	The internal endpoint.	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	Whether the public endpoint is enabled. Valid values: true false	false
PublicHost	string	The public endpoint. Always returned regardless of whether it is enabled. Note If PublicEnable is true, the endpoint is DNS-resolvable. If PublicEnable is false, an invalid endpoint that is not DNS-resolvable is returned.	dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com
HttpsPort	integer	The HTTPS port for connecting to the database instance.	443
ProtocolType	string	The database protocol type, such as MYSQL.	MYSQL
ProtocolPort	integer	The protocol port for database connections.	3306
RegionId	string	The region ID.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "5812180E-555F-5F90-BE4F-280576F4****",
  "Success": true,
  "ErrorMessage": "User can not access to Tenant [123445]",
  "ErrorCode": "UnknownError",
  "ProxyList": [
    {
      "ProxyId": 0,
      "CreatorId": 0,
      "CreatorName": "test_name",
      "InstanceId": 0,
      "PrivateEnable": true,
      "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
      "PublicEnable": false,
      "PublicHost": "dphzmy-5j8oimjsz6ze****-pub.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.