调用GetProxy获取数据安全防护代理的详情信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetProxy

系统规定参数。取值：GetProxy。

InstanceId Long 否 183****

实例ID，可通过调用接口ListInstances或GetInstance获取该参数的值。

ProxyId Long 否 4**

安全防护代理ID，可通过调用接口ListProxies获取该参数。

Tid Long 否 3***

租户ID，可通过调用接口GetUserActiveTenant获取该参数的值。

RegionId String 否 cn-hangzhou

DMS服务地域，请您根据应用所在地就近选择。取值请参见RegionID参数说明。

返回数据

名称 类型 示例值 描述
RequestId String F49D4598-2B3C-5723-865E-2CCB818E****

请求ID。
Success Boolean true

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败
ErrorMessage String The condition cannot be empty!

错误信息。
ErrorCode String UnknownError

错误码。
ProxyId Long 4**

安全防护代理ID。
CreatorId Long 12****

安全防护代理创建人的用户ID。
CreatorName String test_name

安全防护代理创建人的用户昵称。
InstanceId Long 183****

实例ID。
PrivateEnable Boolean true

是否开启内网地址，默认返回值为true。

PrivateHost String dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com

内网地址。
PublicEnable Boolean true

是否开启公网地址，返回值如下：

  • true：启用
  • false：禁用
PublicHost String dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com

公网地址，公网地址始终都会返回。

说明
  • 当公网地址的开启状态为true时，此处返回的公网地址为有DNS解析能力的有效地址。
  • 当公网地址的开启状态为false时，此处返回的公网地址为无DNS解析能力的无效地址。
MysqlPort Integer 3306

MySQL协议端口号。
HttpsPort Integer 443

HTTPS协议端口号。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetProxy
&InstanceId=183****
&ProxyId=4**
&Tid=3***
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<GetProxyResponse>
    <PublicHost>dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com</PublicHost>
    <PrivateHost>dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com</PrivateHost>
    <RequestId>F49D4598-2B3C-5723-865E-2CCB818E****</RequestId>
    <InstanceId>183****</InstanceId>
    <ProxyId>4**</ProxyId>
    <CreatorId>12****</CreatorId>
    <Success>true</Success>
    <MysqlPort>3306</MysqlPort>
    <CreatorName>test_name</CreatorName>
    <HttpsPort>443</HttpsPort>
</GetProxyResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PublicHost" : "dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com",
  "PrivateHost" : "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
  "RequestId" : "F49D4598-2B3C-5723-865E-2CCB818E****",
  "InstanceId" : "183****",
  "ProxyId" : "4**",
  "CreatorId" : "12****",
  "Success" : true,
  "MysqlPort" : 3306,
  "CreatorName" : "test_name",
  "HttpsPort" : 443
}

错误码

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