Queries the details about a secure access proxy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetProxy

The operation that you want to perform. Set the value to GetProxy.

InstanceId Long No 183****

The ID of the database instance. You can call the ListInstances or GetInstance operation to query the database instance ID.

ProxyId Long No 4**

The ID of the secure access proxy. You can call the ListProxies operation to query the ID of the secure access proxy.

Tid Long No 3***

The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.

RegionId String No cn-hangzhou

The region in which DMS is activated. For more information, see RegionID parameter.

Response parameters

Parameter Type Example Description
RequestId String F49D4598-2B3C-5723-865E-2CCB818E****

The ID of the request.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
ErrorMessage String The condition cannot be empty!

The error message returned.

ErrorCode String UnknownError

The error code returned.

ProxyId Long 4**

The ID of the secure access proxy.

CreatorId Long 12****

The ID of the user who enabled the secure access proxy feature.

CreatorName String test_name

The nickname of the user who enabled the secure access proxy feature.

InstanceId Long 183****

The ID of the database instance.

PrivateEnable Boolean true

Indicates whether the internal endpoint is enabled. Default value: true.

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

The internal endpoint.

PublicEnable Boolean true

Indicates whether the public endpoint is enabled. Valid values:

  • true: The public endpoint is enabled.
  • false: The public endpoint is disabled.
PublicHost String dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com

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.
MysqlPort Integer 3306

The port that was used by MySQL clients to connect to the database instance.

HttpsPort Integer 443

The port that was used by HTTPS clients to connect to the database instance.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=GetProxy
&InstanceId=183****
&ProxyId=4**
&Tid=3***
&Common request parameter

Sample success responses

XML format

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 format

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
}

Error codes

For a list of error codes, visit the API Error Center.