首页 云连接器 API参考指南 API目录 云连接器 ListIoTCloudConnectors - 查询云连接器实例信息

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

查询云连接器实例信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
iotcc:ListIoTCloudConnectorsRead
  • UIS
    acs:iotcc:{#regionId}:{#accountId}:cloudconnector/*
    无
无

请求参数

名称类型必填描述示例值
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
IoTCloudConnectorsarray

云连接器实例列表。

object

云连接器实例列表。

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
阿里云首页 云连接器 相关技术圈