ListConnectors - 批量查询Connector

批量查询当前阿里云账号下Connector实例。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
csas:ListConnectorsget
  • 全部资源
    *

请求参数

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

分页查询时显示的当前页的页码。取值:1~10000。

1
PageSizeinteger

分页查询时设置的每页数量。取值:1~1000。

10
Namestring

Connector 名称。长度为 1~128 个字符,支持中文和大小写英文字母,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

connector_name
Statusstring

Connector 连接状态。取值:

  • Online:在线。
  • Offline:离线。
Online
SwitchStatusstring

Connector 实例状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
ConnectorIdsarray

ConnectorID 集合。最多可输入 100 个 ConnectorID。

string

ConnectorID。取值来源: ListConnectors 批量查询 Connector。

connector-94db94e06b98****

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

58D6B23E-E5DA-5418-8F61-51A3B5A30049
TotalNuminteger

Connector 总数。

1
Connectorsarray<object>

Connector 列表。

connectorobject

Connector。

ConnectorIdstring

ConnectorID。

connector-94db94e06b98****
Namestring

Connector 名称。

connector_name
RegionIdstring

地域 ID。

cn-hangzhou
SwitchStatusstring

Connector 实例状态。取值:

  • Enabled:开启。
  • Disabled:关闭。
Enabled
Statusstring

Connector 连接状态。取值:

  • Online:在线。
  • Offline:离线。
Online
Applicationsarray<object>

关联的内网访问应用集合。

applicationobject

关联的内网访问应用。

ApplicationIdstring

内网访问应用 ID。

pa-application-e12860ef6c48****
ApplicationNamestring

内网访问应用名称。

application_name
UpgradeTimeobject

Connector 升级时间。

Startstring

开始时间。

20:00
Endstring

结束时间。

23:00
ConnectorClientsarray<object>

部署的 ConnectorClient 集合。

connectorClientobject

部署的 ConnectorClient。

DevTagstring

ConnectorClient 的设备唯一标识。

C50A2386-F851-4F11-920B-DF7148DA0C22
Hostnamestring

ConnectorClient 主机名。

connector_client
ConnectionStatusstring

ConnectorClient 和 ConnectorServer 的连接状态。

枚举值:
  • Connected已连接
  • Disconnected未连接
Disconnected
PublicIpstring

ConnectorClient 公网 IP。

192.0.2.1
CreateTimestring

Connector 创建时间。

2022-09-27 18:10:25

示例

正常返回示例

JSON格式

{
  "RequestId": "58D6B23E-E5DA-5418-8F61-51A3B5A30049",
  "TotalNum": 1,
  "Connectors": [
    {
      "ConnectorId": "connector-94db94e06b98****",
      "Name": "connector_name",
      "RegionId": "cn-hangzhou",
      "SwitchStatus": "Enabled",
      "Status": "Online",
      "Applications": [
        {
          "ApplicationId": "pa-application-e12860ef6c48****\n",
          "ApplicationName": "application_name"
        }
      ],
      "UpgradeTime": {
        "Start": "20:00",
        "End": "23:00"
      },
      "ConnectorClients": [
        {
          "DevTag": "C50A2386-F851-4F11-920B-DF7148DA0C22",
          "Hostname": "connector_client",
          "ConnectionStatus": "Disconnected",
          "PublicIp": "192.0.2.1"
        }
      ],
      "CreateTime": "2022-09-27 18:10:25"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-30OpenAPI 返回结构发生变更查看变更详情
2023-04-12OpenAPI 入参发生变更查看变更详情