ListProxies - Data Management - Alibaba Cloud Documentation Center

Queries the proxies that are generated by 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:ListProxies	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant 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.	5812180E-555F-5F90-BE4F-280576F4****
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.	User can not access to Tenant [123445]
ErrorCode	string	The error code.	UnknownError
ProxyList	array<object>	The proxies that are generated by the secure access proxy feature.
ProxyList	object	The proxy that is generated by the secure access proxy feature.
ProxyId	long	The ID of the secure access proxy.	4**
CreatorId	long	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	long	The ID of the instance.	183****
PrivateEnable	boolean	Indicates whether the internal endpoint is enabled. Default value: true.	true
PrivateHost	string	The internal endpoint.	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	Indicates whether the public endpoint is enabled. Valid values: true: The public endpoint is enabled. false: The public endpoint is disabled.	false
PublicHost	string	The public endpoint. A public endpoint is returned no matter whether the public endpoint is enabled or disabled. Note If the value of the PublicEnable parameter is true, a valid public endpoint that can be resolved by using Alibaba Cloud DNS (DNS) is returned. If the value of the PublicEnable parameter is false, an invalid public endpoint that cannot be resolved by using DNS is returned.	dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com
HttpsPort	integer	The number of the port that was used by HTTPS clients to connect to the database instance.	443
ProtocolType	string	The type of the database. Example: MYSQL.	MYSQL
ProtocolPort	integer	The number of the port that is used to connect the database instance.	3306
RegionId	string	The ID of the region.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history