文档

ListIoTCloudConnectorGroups - 查询实例组列表信息

更新时间:

查询实例组列表信息。

调试

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

授权信息

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

请求参数

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

实例组的状态。最多支持 20 个实例组的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

string

实例组的状态。最多支持 20 个实例组的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

Created
IoTCloudConnectorGroupIdsarray

实例组的 ID 列表。最多支持 20 个实例组的 ID 列表。

string

实例组的 ID 列表。最多支持 20 个实例组的 ID 列表。

iotccg-g00epppbi9di9y****
IoTCloudConnectorGroupNamearray

实例组的名称。最多支持 20 个实例组的名称。

string

实例组的名称。最多支持 20 个实例组的名称。

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

cctest
NextTokenstring

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

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

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

10
RegionIdstring

实例组所在的地域 ID。

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

cn-hangzhou
Typestring

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

  • Basic:基础版。

  • Standard:标准版。

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

Standard

返回参数

名称类型描述示例值
object

返回信息列表。

TotalCountinteger

列表条目数。

10
NextTokenstring

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

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

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

10
RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
IoTCloudConnectorGroupsobject []

实例组列表信息。

IoTCloudConnectorGroupIdstring

实例组 ID。

iotccg-g00epppbi9di9y****
IoTCloudConnectorGroupStatusstring

实例组的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

Created
IoTCloudConnectorsobject []

云连接器实例列表。

IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****
IoTCloudConnectorStatusstring

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

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:修改中。

Created
IoTCloudConnectorNamestring

云连接器实例的名称。

cc01
IoTCloudConnectorDescriptionstring

云连接器实例描述信息。

cc01
CreateTimelong

云连接器实例创建时间。

2021-10-01 00:00:00
ISPstring

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

  • telecom:中国电信。

  • mobile:中国移动。

  • unicom:中国联通。

mobile
APNstring

运营商 APN ID。

CMWAP
ServiceTypestring

服务类型。取值:

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

实例组的名称。

cctest
Descriptionstring

实例组的描述信息。

test
CreateTimelong

实例组的创建时间。

2021-10-01 00:00:00
Typestring

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

  • Basic:基础版。

  • Standard:标准版。

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

Standard
ServiceTypestring

服务类型。取值:

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

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 10,
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "IoTCloudConnectorGroups": [
    {
      "IoTCloudConnectorGroupId": "iotccg-g00epppbi9di9y****",
      "IoTCloudConnectorGroupStatus": "Created",
      "IoTCloudConnectors": [
        {
          "IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
          "IoTCloudConnectorStatus": "Created",
          "IoTCloudConnectorName": "cc01",
          "IoTCloudConnectorDescription": "cc01",
          "CreateTime": 0,
          "ISP": "mobile",
          "APN": "CMWAP",
          "ServiceType": "Normal"
        }
      ],
      "Name": "cctest",
      "Description": "test",
      "CreateTime": 0,
      "Type": "Standard",
      "ServiceType": "Normal"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。

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

变更历史

变更时间变更内容概要操作
2022-06-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Type
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈