You can call this operation to obtain the details of a data security protection agent.

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 1

The ID of the instance. You can call the GetInstance or ListInstances operation to obtain this parameter.

ProxyId Long No 1

The ID of the security protection agent. You can call the ListProxies operation to obtain this parameter.

You must specify at least one of this parameter and the Instance ID parameter.

Tid Long No 1

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain this parameter.

RegionId String No cn-hangzhou

Select the service region of DMS. This operation is used to call this operation. For more information, see RegionID parameter description.

Note Set this parameter to the ID of the region that is in proximity to your applications.

Response parameters

Parameter Type Sample response Description
RequestId String 0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

ErrorMessage String UnknownError

The error message that is returned.

ErrorCode String 200

The error code returned to the query task.

ProxyId Long 1

The ID of the security protection agent.

CreatorId Long 1

The user ID of the security protection agent creator.

CreatorName String xxx

The user nickname of the creator of the security protection agent.

InstanceId Long 123456

The ID of the instance.

PrivateEnable Boolean true

Specifies whether to enable the internal endpoint.

PrivateHost String xxx.dms.aliyuncs.com

The internal IP address.

PublicEnable Boolean true

Specifies whether to enable public endpoint.

PublicHost String xxx.dms.aliyuncs.com

Public endpoint.

MysqlPort Integer 3306

The port number of the MySQL protocol.

HttpsPort Integer 443

The port number of the Https protocol.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetProxy
&InstanceId=1
&ProxyId=1
&Tid=1
&<Common request parameters>

Sample responses

XML format

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

<GetProxyResponse>
    <PublicHost>dxxxxy-zxxxxxx7xxxxxxmd-pub.proxy.dms.aliyuncs.com</PublicHost>
    <PrivateHost>dxxxxy-zxxxxxx7xxxxxxmd.proxy.dms.aliyuncs.com</PrivateHost>
    <RequestId>F7DB3F39-062D-50BA-BB10-326BF88E332A</RequestId>
    <InstanceId>1</InstanceId>
    <ProxyId>9</ProxyId>
    <CreatorId>200000</CreatorId>
    <Success>true</Success>
    <MysqlPort>3306</MysqlPort>
    <CreatorName>exxxx</CreatorName>
    <HttpsPort>443</HttpsPort>
</GetProxyResponse>

JSON format

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

{
  "PublicHost" : "dxxxxy-zxxxxxx7xxxxxxmd-pub.proxy.dms.aliyuncs.com",
  "PrivateHost" : "dxxxxy-zxxxxxx7xxxxxxmd.proxy.dms.aliyuncs.com",
  "RequestId" : "F7DB3F39-062D-50BA-BB10-326BF88E332A",
  "InstanceId" : 1,
  "ProxyId" : 9,
  "CreatorId" : 200000,
  "Success" : true,
  "MysqlPort" : 3306,
  "CreatorName" : "exxxx",
  "HttpsPort" : 443
}

Error codes

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