GetCard - 获取单卡信息

更新时间:

获取单卡信息。

调试

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

授权信息

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

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

请求参数

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

物联网卡的 iccid。

11111111111

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 iD

0B28B72A-BD16-51F7-AAEE-55247FE02729
Iccidstring

物联网卡的 iccid。

111111111
NetTypestring

网络类型,取值:

  • 4G
  • 5G
5G
APNstring

运营商 APN 的 id。

zjalyjs01s.5gjs.njiot
ISPstring

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

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

物联网卡的固定 IP 地址。

172.24.2.121
Imsistring

物联网卡的 IMSI。

12123123
Imeistring

设备 IMEI。

23412313513512
Lockstring

卡是否锁定。

true
Specstring

规格

CONSUMER_THREE_IN_ONE
SimStatusstring

卡的状态,取值:

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

实例状态,取值:

  • Creating: 创建中
  • Available: 有效的稳定状态
  • UnAvailable: 无效状态
  • Pending: 配置中
  • Deleting: 删除中
Available
Descriptionstring

描述。

task-test
Namestring

名称。

test
WirelessCloudConnectorIdstring

5G 高速上云实例 id。

cc5g-xxxxxxx
CloudConnectorIdstring

云连接 id。

iotcc-xxxxxxxx
UsageDataMonthinteger

本月已用流量,单位 MB。 本字段信息存在一些外部条件等影响,会出现信息同步滞后,建议使用 ListCardUsages 查询单卡流量信息。

50
OrderIdstring

订单 id。

12312341234124
ActivatedTimestring

激活时间。

2022-08-25 17:34:57
Msisdnstring

物联网卡的 MSISDN。

2312341231235
UsageDataTotallong

单卡总使用量,单位 MB。

1000
LimitThresholdlong

达量限速阈值,单位 MB。

50
StopThresholdlong

达量停机阈值,单位 MB。

4096
AlarmThresholdlong

告警阈值,单位 MB。

1000

示例

正常返回示例

JSON格式

{
  "RequestId": "0B28B72A-BD16-51F7-AAEE-55247FE02729",
  "Iccid": 111111111,
  "NetType": "5G",
  "APN": "zjalyjs01s.5gjs.njiot",
  "ISP": "Unicom",
  "IpAddress": "172.24.2.121",
  "Imsi": 12123123,
  "Imei": 23412313513512,
  "Lock": true,
  "Spec": "CONSUMER_THREE_IN_ONE",
  "SimStatus": "Deactivated",
  "Status": "Available",
  "Description": "task-test",
  "Name": "test",
  "WirelessCloudConnectorId": "cc5g-xxxxxxx",
  "CloudConnectorId": "iotcc-xxxxxxxx",
  "UsageDataMonth": 50,
  "OrderId": 12312341234124,
  "ActivatedTime": "2022-08-25 17:34:57",
  "Msisdn": 2312341231235,
  "UsageDataTotal": 1000,
  "LimitThreshold": 50,
  "StopThreshold": 4096,
  "AlarmThreshold": 1000
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史