ListProxies - 获取安全访问代理列表 - 数据管理 DMS

获取安全访问代理列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:ListProxies	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	5812180E-555F-5F90-BE4F-280576F4****
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorMessage	string	错误信息。	User can not access to Tenant [123445]
ErrorCode	string	错误码。	UnknownError
ProxyList	array<object>	安全访问代理列表。
ProxyList	object	安全访问代理列表。
ProxyId	long	安全访问代理 ID。	4**
CreatorId	long	安全访问代理创建人的用户 ID。	12****
CreatorName	string	安全访问代理创建人的用户昵称。	test_name
InstanceId	long	实例 ID。	183****
PrivateEnable	boolean	是否开启内网。默认返回值为 true。	true
PrivateHost	string	内网地址。	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	是否开启公网，返回值如下： true：启用 false：禁用	false
PublicHost	string	公网地址，公网地址始终都会返回。说明当公网地址的开启状态为 true 时，此处返回的公网地址为有 DNS 解析能力的有效地址。当公网地址的开启状态为 false 时，此处返回的公网地址为无 DNS 解析能力的无效地址。	dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com
HttpsPort	integer	HTTPS 协议端口号。	443
ProtocolType	string	数据库协议类型，例如：MYSQL	MYSQL
ProtocolPort	integer	数据库协议连接端口号	3306
RegionId	string	实例地区	cn-hangzhou

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史