All Products
Search

This Product

    Data Management:GetProxy

    Document Center

    Data Management:GetProxy

    Last Updated:Nov 28, 2024

    Queries the details of a secure access proxy.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    dms:GetProxyget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ProxyIdlongYes

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

    		4**
    TidlongNo

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

    		3***

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The ID of the request.

    		F49D4598-2B3C-5723-865E-2CCB818E****
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		true
    ErrorMessagestring

    The error message returned if the request failed.

    		The condition cannot be empty!
    ErrorCodestring

    The error code returned if the request failed.

    		UnknownError
    ProxyIdlong

    The ID of the secure access proxy.

    		4**
    CreatorIdlong

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

    		12****
    CreatorNamestring

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

    		test_name
    InstanceIdlong

    The ID of the instance.

    		183****
    PrivateEnableboolean

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

    		true
    PrivateHoststring

    The internal endpoint.

    		dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
    PublicEnableboolean

    Indicates whether the public endpoint was enabled. Valid values:

    • true: The public endpoint was enabled.
    • false: The public endpoint was disabled.
    		true
    PublicHoststring

    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 is returned.

    • If the value of the PublicEnable parameter is false, an invalid public endpoint that cannot be resolved by using Alibaba Cloud DNS is returned.

    		dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com
    HttpsPortinteger

    The port number used by the HTTPS protocol.

    		443
    ProtocolTypestring

    The protocol type of the database. Example: MYSQL.

    		MYSQL
    ProtocolPortinteger

    The port number used by the protocol.

    		3306
    RegionIdstring

    The ID of the region in which the instance resides.

    		cn-hangzhou

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history