全部产品
Search
文档中心

数据管理 DMS:ListProxies - 获取安全访问代理列表

更新时间:Jul 15, 2024

获取安全访问代理列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Tidlong

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

3***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrorMessagestring

错误信息。

User can not access to Tenant [123445]
ErrorCodestring

错误码。

UnknownError
ProxyListarray<object>

安全访问代理列表。

object

安全访问代理列表。

ProxyIdlong

安全访问代理 ID。

4**
CreatorIdlong

安全访问代理创建人的用户 ID。

12****
CreatorNamestring

安全访问代理创建人的用户昵称。

test_name
InstanceIdlong

实例 ID。

183****
PrivateEnableboolean

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

true
PrivateHoststring

内网地址。

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

是否开启公网,返回值如下:

  • true:启用
  • false:禁用
false
PublicHoststring

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

说明
  • 当公网地址的开启状态为 true 时,此处返回的公网地址为有 DNS 解析能力的有效地址。
  • 当公网地址的开启状态为 false 时,此处返回的公网地址为无 DNS 解析能力的无效地址。
  • dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com
    HttpsPortinteger

    HTTPS 协议端口号。

    443
    ProtocolTypestring

    数据库协议类型,例如:MYSQL

    MYSQL
    ProtocolPortinteger

    数据库协议连接端口号

    3306
    RegionIdstring

    实例地区

    cn-hangzhou

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史