All Products
Search
Document Center

Data Management:ListProxies

最終更新日:Oct 21, 2024

Queries the proxies that are generated by the secure access proxy feature.

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

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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

3***

Response parameters

ParameterTypeDescriptionExample
object

The schema of the response.

RequestIdstring

The ID of the request.

5812180E-555F-5F90-BE4F-280576F4****
Successboolean

Indicates whether the request was successful. Valid values:

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

The error message.

User can not access to Tenant [123445]
ErrorCodestring

The error code.

UnknownError
ProxyListarray<object>

The proxies that are generated by the secure access proxy feature.

ProxyListobject

The proxy that is generated by the secure access proxy feature.

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 is enabled. Default value: true.

true
PrivateHoststring

The internal endpoint.

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

Indicates whether the public endpoint is enabled. Valid values:

  • true: The public endpoint is enabled.
  • false: The public endpoint is disabled.
false
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 (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.

dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com
HttpsPortinteger

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

443
ProtocolTypestring

The type of the database. Example: MYSQL.

MYSQL
ProtocolPortinteger

The number of the port that is used to connect the database instance.

3306
RegionIdstring

The ID of the region.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "5812180E-555F-5F90-BE4F-280576F4****",
  "Success": true,
  "ErrorMessage": "User can not access to Tenant [123445]",
  "ErrorCode": "UnknownError",
  "ProxyList": [
    {
      "ProxyId": 0,
      "CreatorId": 0,
      "CreatorName": "test_name",
      "InstanceId": 0,
      "PrivateEnable": true,
      "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
      "PublicEnable": false,
      "PublicHost": "dphzmy-5j8oimjsz6ze****-pub.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