该接口用于查询指定条件下的物联网卡列表。
使用说明
该接口的请求参数您可以在物联网SIM服务控制台查看并获取,或者调用接口GetCardDetail在返回参数中查看并获取(后者更为推荐)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ListCardInfo | 系统规定参数。取值:ListCardInfo。 |
ActiveTimeEnd | String | 否 | 2022-05-25 23:59:59 | 物联网卡的激活时间区间:结束时间。 格式为: |
PageSize | Integer | 是 | 10 | 每页的数量,支持10、15、25、40。 |
Iccid | String | 否 | 89860321******15668 | 物联网卡的ICCID。 您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面查看ICCID。 |
CredentialNo | String | 否 | CM-***-*-2-**M | 套餐凭证。 |
Vendor | String | 否 | CMCC | 运营商。
|
PageNo | Integer | 是 | 1 | 查询页数,需结合PageSize参数组合使用。 |
Msisdn | String | 否 | 1440993****** | 物联网卡的MSISDN。 |
AliyunOrderId | String | 否 | 211519634****** | 物联网卡关联的订单编号。 |
AliFee | String | 否 | ali_2 | 资费版本。 |
Period | String | 否 | 1101 | 套餐结算周期。
|
DataType | String | 否 | sameflowcard | 流量类型。
|
ActiveTimeStart | String | 否 | 2022-05-25 23:59:59 | 物联网卡的激活时间区间:开始时间。 格式为: |
SimType | String | 否 | nano | SIM卡类型。
|
ExpireTimeEnd | String | 否 | 2022-05-25 23:59:59 | 物联网卡的套餐结束时间。 格式为: |
IsAutoRecharge | Boolean | 否 | true | 套餐是否自动续费。
|
ExpireTimeStart | String | 否 | 2022-05-25 23:59:59 | 物联网卡的套餐开始时间。 格式为: |
OsStatus | String | 否 | 300 | 物联网卡的具体状态。
|
NotifyId | String | 否 | 11111 | 自动化规则的通知ID。 |
DataLevel | String | 否 | 30MB | 流量包档位。 |
Status | String | 否 | 35 | 物联网卡的状态。
|
TagName | String | 否 | 测试标签 | 标签名称。 |
CertifyType | String | 否 | enterprise | 认证方式。 仅支持enterprise:企业认证。 |
DirectionalGroupId | String | 否 | 22 | 定向分组ID。 |
ApnName | String | 否 | cmiot | APN名称。 |
Imsi | String | 否 | 460081937****** | 物联网卡的IMSI。 |
PoolId | String | 否 | test1 | 池编号。 |
MinFlow | String | 否 | 20 | 周期用量区间筛选:最小用量(单位MB)。 |
MaxFlow | String | 否 | 30 | 周期用量区间筛选:最大用量(单位MB)。 |
MaxRestFlowPercentage | double | 否 | 0.2 | 单卡周期流量剩余比例,仅支持如下三个参数。 0.1:剩余10% 0.2:剩余20% 0.3:剩余30% |
NetworkType | String | 否 | 4G | 网络制式:4G,5G。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | 200 | 接口返回码。
|
ErrorMessage | String | InstanceId cannot be empty. | 调用失败时,返回的错误信息。 |
RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 | 请求ID,阿里云为该请求生成的标识符。 |
Success | Boolean | true | 是否调用成功。
|
LocalizedMessage | String | InstanceId cannot be empty. | 根据当前所在地展示对应语言的错误提示。 |
Data | Object | 返回页面信息。 |
|
PageNo | Integer | 1 | 查询页数。 |
PageSize | Integer | 10 | 每页显示的数量。 |
PageCount | Integer | 20 | 总页数。 |
Total | Integer | 199 | 符合条件的物联网卡总数。 |
List | Array of CardDTO | 卡列表。 |
|
Status | String | 35 | 卡的状态。
|
DataType | String | sameflowcard | 流量类型。
|
DirectionalGroupName | String | 测试分组 | 定向分组名称。 |
PeriodRestFlow | String | 130.00MB | 周期剩余流量。 |
CredentialType | String | unityPayPool | 套餐凭证类型。 |
PeriodAddFlow | String | 0KB | 周期累计流量。 |
PeriodSmsUse | String | 0 | 周期短信用量。 |
DataLevel | String | 30MB | 流量包档位。 |
OsStatus | String | 300 | 物联网卡的具体状态。
|
NotifyId | String | 11111 | 自动化规则的通知ID。 |
AliFee | String | ali_2 | 资费版本。 |
AliyunOrderId | String | 211519634****** | 物联网卡关联的订单编号。 |
ActiveType | String | first_data_record | 物联网卡的激活方式。
|
IsAutoRecharge | Boolean | true | 套餐是否自动续费。
|
CredentialInstanceId | String | 2622*** | 凭证实例ID。 |
ExpireTime | String | 2022-04-30 23:59:59 | 套餐到期时间。 |
ApnName | String | cmiot | APN名称。 |
ActiveTime | String | 2021-11-16 16:35:50 | 激活时间。 |
Iccid | String | 89860321******15668 | 物联网卡的ICCID。 |
Vendor | String | CMCC | 运营商。
|
Period | String | 1101 | 套餐结算周期。
|
CertifyType | String | enterprise | 认证方式。 enterprise:企业认证。 |
PrivateNetworkSegment | String | 1.*.3.* | 私网网段(定向卡)。 |
OpenAccountTime | String | 2021-11-29 16:12:14 | 开户时间。 |
SimType | String | nano | SIM卡类型。
|
VsimInstanceId | Long | 123456 | 物联网卡的InstanceId值。 |
CredentialNo | String | CM-***-*-2-**M | 套餐凭证。 |
TagList | Array of TagList | 物联网卡的标签。 |
|
TagName | String | 测试标签 | 标签名称。 |
Id | Long | 24 | 标签ID。 |
Imsi | Array of String | 460081937****** | 物联网卡的IMSI。 |
Msisdn | Array of String | 1440993****** | 物联网卡的MSISDN。 |
Remark | String | 备注信息 | 备注信息。 |
DirectionalGroupId | Long | 55 | 定向分组ID。 |
NetworkType | String | 4G | 网络制式:4G,5G。 |
FlowLatestModifiedTime | String | 2023-08-15 18:20:11 | 用量更新时间 |
示例
请求示例
http(s)://linkcard.aliyuncs.com/?Action=ListCardInfo
&ActiveTimeEnd=2022-05-25 23:59:59
&PageSize=10
&Iccid=89860321******15668
&CredentialNo=CM-***-*-2-**M
&Vendor=CMCC
&PageNo=1
&Msisdn=1440993******
&AliyunOrderId=211519634******
&AliFee=ali_2
&Period=1101
&DataType=sameflowcard
&ActiveTimeStart=2022-05-25 23:59:59
&SimType=nano
&ExpireTimeEnd=2022-05-25 23:59:59
&IsAutoRecharge=true
&ExpireTimeStart=2022-05-25 23:59:59
&OsStatus=300
&NotifyId=11111
&DataLevel=30MB
&Status=35
&TagName=测试标签
&CertifyType=enterprise
&DirectionalGroupId=22
&ApnName=cmiot
&Imsi=460081937******
&PoolId=test1
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListCardInfoResponse>
<Code>200</Code>
<ErrorMessage>InstanceId cannot be empty.</ErrorMessage>
<RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
<Success>true</Success>
<LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>
<Data>
<PageNo>1</PageNo>
<PageSize>10</PageSize>
<PageCount>20</PageCount>
<Total>199</Total>
<List>
<Status>35</Status>
<DataType>sameflowcard</DataType>
<DirectionalGroupName>测试分组</DirectionalGroupName>
<PeriodRestFlow>130.00MB</PeriodRestFlow>
<CredentialType>unityPayPool</CredentialType>
<PeriodAddFlow>0KB</PeriodAddFlow>
<PeriodSmsUse>0</PeriodSmsUse>
<DataLevel>30MB</DataLevel>
<OsStatus>300</OsStatus>
<NotifyId>11111</NotifyId>
<AliFee>ali_2</AliFee>
<AliyunOrderId>211519634******</AliyunOrderId>
<ActiveType>first_data_record</ActiveType>
<IsAutoRecharge>true</IsAutoRecharge>
<CredentialInstanceId>2622***</CredentialInstanceId>
<ExpireTime>2022-04-30 23:59:59</ExpireTime>
<ApnName>cmiot</ApnName>
<ActiveTime>2021-11-16 16:35:50</ActiveTime>
<Iccid>89860321******15668</Iccid>
<Vendor>CMCC</Vendor>
<Period>1101</Period>
<CertifyType>enterprise</CertifyType>
<PrivateNetworkSegment>1.*.3.*</PrivateNetworkSegment>
<OpenAccountTime>2021-11-29 16:12:14</OpenAccountTime>
<SimType>nano</SimType>
<VsimInstanceId>123456</VsimInstanceId>
<CredentialNo>CM-***-*-2-**M</CredentialNo>
<TagList>
<TagName>测试标签</TagName>
<Id>24</Id>
</TagList>
<Imsi>460081937******</Imsi>
<Msisdn>1440993******</Msisdn>
<Remark>备注信息</Remark>
<DirectionalGroupId>55</DirectionalGroupId>
</List>
</Data>
</ListCardInfoResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : "200",
"ErrorMessage" : "InstanceId cannot be empty.",
"RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
"Success" : true,
"LocalizedMessage" : "InstanceId cannot be empty.",
"Data" : {
"PageNo" : 1,
"PageSize" : 10,
"PageCount" : 20,
"Total" : 199,
"List" : [ {
"Status" : "35",
"DataType" : "sameflowcard",
"DirectionalGroupName" : "测试分组",
"PeriodRestFlow" : "130.00MB",
"CredentialType" : "unityPayPool",
"PeriodAddFlow" : "0KB",
"PeriodSmsUse" : "0",
"DataLevel" : "30MB",
"OsStatus" : "300",
"NotifyId" : "11111",
"AliFee" : "ali_2",
"AliyunOrderId" : "211519634******",
"ActiveType" : "first_data_record",
"IsAutoRecharge" : true,
"CredentialInstanceId" : "2622***",
"ExpireTime" : "2022-04-30 23:59:59",
"ApnName" : "cmiot",
"ActiveTime" : "2021-11-16 16:35:50",
"Iccid" : "89860321******15668",
"Vendor" : "CMCC",
"Period" : "1101",
"CertifyType" : "enterprise",
"PrivateNetworkSegment" : "1.*.3.*",
"OpenAccountTime" : "2021-11-29 16:12:14",
"SimType" : "nano",
"VsimInstanceId" : 123456,
"CredentialNo" : "CM-***-*-2-**M",
"TagList" : [ {
"TagName" : "测试标签",
"Id" : 24
} ],
"Imsi" : [ "460081937******" ],
"Msisdn" : [ "1440993******" ],
"Remark" : "备注信息",
"DirectionalGroupId" : 55
} ]
}
}