ListConnectors - Batch Query Connectors

更新时间:
复制 MD 格式

Batch query connectors。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

csas:ListConnectors

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

CurrentPage

integer

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

1

PageSize

integer

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

10

Name

string

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

connector_name

Status

string

Connector 连接状态。取值:

  • Online:在线。

  • Offline:离线。

枚举值:

  • Offline :

    离线

  • Online :

    在线

Online

SwitchStatus

string

Connector 实例状态。取值:

  • Enabled:开启。

  • Disabled:关闭。

枚举值:

  • Enabled :

    开启

  • Disabled :

    关闭

Enabled

ConnectorIds

array

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

string

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

connector-94db94e06b98****

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次请求的 ID。

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

TotalNum

integer

Connector 总数。

1

Connectors

array<object>

Connector 列表。

array<object>

Connector。

ConnectorId

string

ConnectorID。

connector-94db94e06b98****

Name

string

Connector 名称。

connector_name

RegionId

string

地域 ID。

cn-hangzhou

SwitchStatus

string

Connector 实例状态。取值:

  • Enabled:开启。

  • Disabled:关闭。

枚举值:

  • Enabled :

    开启

  • Disabled :

    关闭

Enabled

Status

string

Connector 连接状态。取值:

  • Online:在线。

  • Offline:离线。

枚举值:

  • Offline :

    离线

  • Online :

    在线

Online

Applications

array<object>

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

object

关联的内网访问应用。

ApplicationId

string

内网访问应用 ID。

pa-application-e12860ef6c48****

ApplicationName

string

内网访问应用名称。

application_name

UpgradeTime

object

Connector 升级时间。

Start

string

开始时间。

20:00

End

string

结束时间。

23:00

ConnectorClients

array<object>

部署的 ConnectorClient 集合。

object

部署的 ConnectorClient。

DevTag

string

ConnectorClient 的设备唯一标识。

C50A2386-F851-4F11-920B-DF7148DA0C22

Hostname

string

ConnectorClient 主机名。

connector_client

ConnectionStatus

string

ConnectorClient 和 ConnectorServer 的连接状态。

枚举值:

  • Connected :

    已连接

  • Disconnected :

    未连接

Disconnected

PublicIp

string

ConnectorClient 公网 IP。

192.0.2.1

CreateTime

string

Connector 创建时间。

2022-09-27 18:10:25

ClusterIP

string

集群 IP。

1.1.1.1

ClusterPort

string

集群端口。

8000

AccelerateStatus

string

是否启用全球加速。取值:

  • Enabled:开启。

  • Disabled:关闭。

Enabled

VipCidr

string

示例

正常返回示例

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",
      "ClusterIP": "1.1.1.1",
      "ClusterPort": "8000",
      "AccelerateStatus": "Enabled",
      "VipCidr": ""
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情