ListCards - 查询5G高速上云实例下的卡信息

更新时间:

查询5G高速上云实例下的卡信息列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
fivegcc:ListCardsget
*全部资源
*

请求参数

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

5G 高速上云实例 id。

cc5g-xxxx
Statusesarray

卡的状态列表。

string

卡的状态,取值:

  • Testable: 可测试
  • Activatable: 可激活
  • Activated: 已激活
  • Deactivated: 已停用
  • Failed: 已失效
  • Cleared: 已清除
  • Replaced: 已更换
  • Resuming: 恢复中
  • ShutDown: 已停机
Activated
Iccidsarray

物联网卡的 iccid 列表。

string

物联网卡的 iccid。

89091231231219123
IpAddressstring

物联网卡的固定 IP 地址。

10.0.0.1
Lockboolean

卡是否锁定。

true
Onlineboolean

卡是否在线。

true
NetLinkIdstring

网络连接 id。

cciot-xxxx
Apnstring

运营商 APN 的 id。

bjaliyun01s.5gbj.bjiot
NextTokenstring

上一页的查询返回的值,首页查询不传值。

iou001238joojjaere
MaxResultslong

分页查询时每页的行数,最大值为 50,默认值为 10

10
Iccidstring

卡的 iccid 的前缀,如果后缀包含字符会去除字符。

8909123123121912
Msisdnstring

物联网卡的 MSISDN。

1441204374591

返回参数

名称类型描述示例值
object

响应对象

RequestIdstring

请求 id。

88C2F32F-B641-5980-B7A5-6907050ABCD1
Cardsarray<object>

卡列表。

Cardobject

RegionItemType

Iccidstring

物联网卡的 iccid。

89091231231219123
NetTypestring

网络类型,取值:

  • 4G
  • 5G
5G
APNstring

运营商 APN 的 id。

bjaliyun01s.5gbj.bjiot
ISPstring

5G 高速上云实例的运营商。取值:

  • Telecom:中国电信
  • Mobile:中国移动
  • Unicom:中国联通
Telecom
IpAddressstring

卡的静态 IP 地址。

10.0.0.118
Imsistring

物联网卡的 IMSI。

8912039123
Imeistring

物联网卡的 IMEI。

7896129300
Lockboolean

卡是否锁定。

false
Specstring

卡的规格,取值:

  • CONSUMER_THREE_IN_ONE: 消费电子级物联网卡_三合一
  • INDUSTRY_PATCH: 工业级物联网贴片卡
  • CONSUMER_PATCH: 消费电子级物联网贴片卡
  • INDUSTRY_GENERAL: 工业级物联网卡_普通
  • INDUSTRY_MICRO: 工业级物联网卡_Micro
  • CONSUMER_GENERAL: 消费电子级物联网卡_普通
  • CONSUMER_TWO_IN_ONE: 消费电子级物联网卡_二合一
  • INDUSTRY_NANO: 工业级物联网卡_Nano
  • CAR_PATCH: 车规级物联网贴片卡
CONSUMER_THREE_IN_ONE
Statusstring

卡的状态,取值:

  • Testable: 可测试
  • Activatable: 可激活
  • Activated: 已激活
  • Deactivated: 已停用
  • Failed: 已失效
  • Cleared: 已清除
  • Replaced: 已更换
  • Resuming: 恢复中
  • ShutDown: 已停机
Activated
Descriptionstring

描述。

test
Namestring

名称。

test
UsageDataMonthlong

本月已用流量,单位 MB。

20
OrderIdstring

订单号。

89099123012
ActivatedTimestring

激活时间。

2022-3-15 22:20:00
BusinessStatusstring

业务状态,取值:

  • Creating: 创建中
  • Available: 稳定状态,有效
  • Configuring: 配置中
  • Deleting: 删除中
Available
Msisdnstring

物联网卡的 MSISDN。

1441204374591
UsageDataTotalstring

单卡总使用量

50
NextTokenstring

下一页查询所需值。

iou001238joojjaere
MaxResultsstring

分页查询时每页的行数,最大值为 50,默认值为 10

10
TotalCountstring

列表的条目数。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "88C2F32F-B641-5980-B7A5-6907050ABCD1",
  "Cards": [
    {
      "Iccid": 89091231231219120,
      "NetType": "5G",
      "APN": "bjaliyun01s.5gbj.bjiot",
      "ISP": "Telecom",
      "IpAddress": "10.0.0.118",
      "Imsi": 8912039123,
      "Imei": 7896129300,
      "Lock": false,
      "Spec": "CONSUMER_THREE_IN_ONE",
      "Status": "Activated",
      "Description": "test",
      "Name": "test",
      "UsageDataMonth": 20,
      "OrderId": 89099123012,
      "ActivatedTime": "2022-3-15 22:20:00",
      "BusinessStatus": "Available",
      "Msisdn": 1441204374591,
      "UsageDataTotal": 50
    }
  ],
  "NextToken": "iou001238joojjaere",
  "MaxResults": 10,
  "TotalCount": 2
}

错误码

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