查询云连接器实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
IoTCloudConnectorStatus | array | 否 | 云连接器实例的状态。最多支持输入 20 个实例状态。取值:
| |
string | 否 | 云连接器实例的状态。最多支持输入 20 个实例状态。取值:
| Created | |
IoTCloudConnectorIds | array | 否 | 云连接器实例 ID 列表。 | |
string | 否 | 云连接器实例 ID 列表。最多支持输入 20 个实例 ID。 | iotcc-bp1odcab8tmno0hdq**** | |
IoTCloudConnectorName | array | 否 | 云连接器实例的名称。最多支持输入 20 个实例名称。 名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。 | |
string | 否 | 云连接器实例的名称。最多支持输入 20 个实例名称。 名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。 | test | |
ISP | array | 否 | 云连接器实例的运营商。最多支持输入 20 个实例的运营商。取值:
| |
string | 否 | 云连接器实例的运营商。最多支持输入 20 个实例的运营商。取值:
| mobile | |
VpcId | array | 否 | 云连接器实例连接的 VPC 的 ID。 | |
string | 否 | 云连接器实例连接的 VPC 的 ID。最多支持输入 20 个 VPC 的 ID。 | vpc-bp1aevy8sofi8mh1q**** | |
APN | array | 否 | 运营商 APN 的 ID。 | |
string | 否 | 运营商 APN 的 ID。最多支持输入 20 个 APN 的 ID。 | CMWAP | |
NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:
| caeba0bbb2be03f84eb48b699f0a**** |
MaxResults | integer | 否 | 分批次查询时每次显示的条目数。取值范围:1~50,默认值:10。 | 10 |
RegionId | string | 是 | 云连接器实例所在的地域 ID。 您可以通过调用 ListRegions 接口获取地域 ID。 | cn-hangzhou |
IsInGroup | boolean | 否 | 是否查询实例组中的实例。取值:
| false |
IoTCloudConnectorGroupId | string | 否 | 云连接器实例组 ID。 | iotccg-g00epppbi9di9y**** |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 20,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 10,
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"IoTCloudConnectors": [
{
"IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
"IoTCloudConnectorStatus": "Created",
"ISP": "mobile",
"IoTCloudConnectorBusinessStatus": "Normal",
"APN": "CMWAP",
"RateLimit": 2,
"VpcId": "vpc-bp1aevy8sofi8mh1q****",
"VSwitchList": [
"vsw-m5e3r57pxkgijcdvfcdvf****"
],
"IoTCloudConnectorName": "test",
"IoTCloudConnectorDescription": "test",
"WildcardDomainEnabled": false,
"CreateTime": 0,
"ModifyTime": 0,
"IoTCloudConnectorGroupId": "iotccg-g00epppbi9di9y****",
"Mode": "PassThrough",
"IpFeature": "192.168.0.1",
"Type": "Standard",
"ServiceType": "Normal",
"GrantAliUid": "253460731706911258"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Forbidden.RAM | Ram user does not have permission to perform this operation. | RAM用户无权限执行此操作。 |
400 | SystemBusy | System is busy, please try again later. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2021-11-18 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|