文档

ListIoTCloudConnectors - 查询云连接器实例信息

更新时间:

查询云连接器实例信息。

调试

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

授权信息

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

请求参数

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

云连接器实例的状态。最多支持输入 20 个实例状态。取值:

  • Creating:创建中。
  • Created:创建完成。
  • Deleting:删除中。
  • Updating:修改中。
string

云连接器实例的状态。最多支持输入 20 个实例状态。取值:

  • Creating:创建中。
  • Created:创建完成。
  • Deleting:删除中。
  • Updating:修改中。
Created
IoTCloudConnectorIdsarray

云连接器实例 ID 列表。

string

云连接器实例 ID 列表。最多支持输入 20 个实例 ID。

iotcc-bp1odcab8tmno0hdq****
IoTCloudConnectorNamearray

云连接器实例的名称。最多支持输入 20 个实例名称。

名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。

string

云连接器实例的名称。最多支持输入 20 个实例名称。

名称长度为 2~128 个字符,以大小写字母或中文开头,可包含数字、下划线(_)或短划线(-)。

test
ISParray

云连接器实例的运营商。最多支持输入 20 个实例的运营商。取值:

  • telecom:中国电信。
  • mobile:中国移动。
  • unicom:中国联通。
string

云连接器实例的运营商。最多支持输入 20 个实例的运营商。取值:

  • telecom:中国电信。
  • mobile:中国移动。
  • unicom:中国联通。
mobile
VpcIdarray

云连接器实例连接的 VPC 的 ID。

string

云连接器实例连接的 VPC 的 ID。最多支持输入 20 个 VPC 的 ID。

vpc-bp1aevy8sofi8mh1q****
APNarray

运营商 APN 的 ID。

string

运营商 APN 的 ID。最多支持输入 20 个 APN 的 ID。

CMWAP
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~50,默认值:10

10
RegionIdstring

云连接器实例所在的地域 ID。

您可以通过调用 ListRegions 接口获取地域 ID。

cn-hangzhou
IsInGroupboolean

是否查询实例组中的实例。取值:

  • true:查询实例组中的实例。

  • false(默认值):不查询实例组中的实例。

  • null:全量查询实例,不区分实例是否在实例组中。

false
IoTCloudConnectorGroupIdstring

云连接器实例组 ID。

iotccg-g00epppbi9di9y****

返回参数

名称类型描述示例值
object

返回信息列表。

TotalCountinteger

总列表条目数。

20
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

10
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
IoTCloudConnectorsobject []

云连接器实例列表。

IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
IoTCloudConnectorStatusstring

云连接器实例的状态。取值:

  • Creating:创建中。
  • Created:创建完成。
  • Deleting:删除中。
  • Updating:修改中。
Created
ISPstring

云连接器实例的运营商。取值:

  • telecom:中国电信。
  • mobile:中国移动。
  • unicom:中国联通。
mobile
IoTCloudConnectorBusinessStatusstring

云连接器实例的运行状态。取值:

  • Normal:正常。
  • Abnormal:不正常。
Normal
APNstring

运营商 APN 的 ID。

CMWAP
RateLimitlong

云连接器实例的带宽峰值。单位:Gbps,取值范围:1~10

2
VpcIdstring

云连接器实例连接的 VPC 的 ID。

vpc-bp1aevy8sofi8mh1q****
VSwitchListarray

交换机 ID。

string

交换机 ID。

vsw-m5e3r57pxkgijcdvfcdvf****
IoTCloudConnectorNamestring

云连接器实例的名称。

test
IoTCloudConnectorDescriptionstring

云连接器实例描述信息。

test
WildcardDomainEnabledboolean

是否开启泛域名功能。取值:

  • true:开启。
  • false:关闭。
false
CreateTimelong

云连接器实例创建时间。

按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

2021-10-01T00:00:00Z
ModifyTimelong

云连接器实例信息修改时间。

按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

2021-10-01T10:00:00Z
IoTCloudConnectorGroupIdstring

云连接器实例组 ID。

iotccg-g00epppbi9di9y****
Modestring

云连接器的属性值。表示当前属于 passTrough 模式时显示回程路由。

PassThrough
IpFeaturestring

动态或静态 IP。

192.168.0.1
Typestring

云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:

  • Basic:基础版。

  • Standard:标准版。

云连接器实例默认创建标准版,如果需要创建基础版实例,请提交工单申请。

Standard
ServiceTypestring

服务类型。取值:

  • Normal:普通型。
  • CC5G:云连接器 5G 实例托管类型。
  • CC5GCCIoT:云连接器 5G 过户类型。
Normal
GrantAliUidstring

阿里云授权者 UID。

253460731706911258

示例

正常返回示例

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错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400SystemBusySystem is busy, please try again later.-

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

变更历史

变更时间变更内容概要操作
2021-11-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
  • 本页导读 (1)
文档反馈