GetProxy - 获取数据安全访问代理的详细信息 - 数据管理 DMS

获取数据安全访问代理的详细信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProxyId	long	是	安全访问代理 ID，可通过调用接口 ListProxies 获取该参数。	4**
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。	3***

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F49D4598-2B3C-5723-865E-2CCB818E****
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrorMessage	string	错误信息。	The condition cannot be empty!
ErrorCode	string	错误码。	UnknownError
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：禁用	true
PublicHost	string	公网地址，公网地址始终都会返回。说明当公网地址的开启状态为 true 时，此处返回的公网地址为有 DNS 解析能力的有效地址。当公网地址的开启状态为 false 时，此处返回的公网地址为无 DNS 解析能力的无效地址。	dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com
HttpsPort	integer	HTTPS 协议端口号。	443
ProtocolType	string	数据库协议类型，例如：MYSQL	MYSQL
ProtocolPort	integer	数据库协议连接端口号	3306
RegionId	string	实例地区	cn-hangzhou

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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

暂无变更历史