批量查询当前阿里云账号下Connector实例。
调试
您可以在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 |
SwitchStatus | string | 否 | Connector 实例状态。取值:
| Enabled |
ConnectorIds | array | 否 | ConnectorID 集合。最多可输入 100 个 ConnectorID。 | |
string | 否 | ConnectorID。取值来源: ListConnectors 批量查询 Connector。 | connector-94db94e06b98**** |
返回参数
示例
正常返回示例
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-30 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-04-12 | OpenAPI 入参发生变更 | 查看变更详情 |