查询卡的详情信息。
限制说明
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | GetCardDetail | 系统规定参数。取值:GetCardDetail。 |
Iccid | String | 是 | 89860321******15668 | 物联网卡的ICCID。 您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面查看ICCID。 |
ShowPsim | Boolean | 否 | false | 是否展示子卡的详情信息,默认为否。
|
InstanceId | String | 否 | 411**** | 物联网卡的实例ID。 只有查询的物联网卡已销户时(即DestroyCard为true)需要填入该参数。 您可以调用接口ListCardInfo在返回参数中查看物联网卡的实例ID(VsimInstanceId)。 |
DestroyCard | Boolean | 否 | false | 查询的物联网卡是否已销户,默认为否。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | 200 | 接口返回码。
|
RequestId | String | E4F94B97-1D64-4080-BFD2-67461667AA43 | 请求ID,阿里云为该请求生成的标识符。 |
ErrorMessage | String | InstanceId cannot be empty. | 调用失败时,返回的错误信息。 |
Success | Boolean | true | 是否调用成功。
|
LocalizedMessage | String | InstanceId cannot be empty. | 根据当前所在地展示对应语言的错误提示。 |
Data | Object | 物联网卡的详情信息。 |
|
ListPsimCards | Array of CardInfo | 多网卡的子卡详情。 |
|
Status | String | 35 | 物联网卡的状态。
|
PrivateNetworkSegment | String | *.2.*.4 | 私网网段(定向卡)。 |
OsStatus | String | 300 | 物联网卡的具体状态。
|
CertifyStatus | String | 2 | 实名认证状态。
|
ApnName | String | cmiot | APN名称。 |
PeriodAddFlow | String | 130.00MB | 周期累计流量。 |
Iccid | String | 89860321******15668 | 子卡的ICCID。 |
Vendor | String | CMCC | 运营商。
|
PeriodSmsUse | String | 0 | 周期短信用量。 |
Imsi | Array of String | 460081937****** | 子卡的IMSI。 |
Msisdn | Array of String | 1411111****** | 子卡的MSISDN。 |
OpenSms | Boolean | true | 短信功能开通情况。
|
Ip | Array of String | 1.1.*.* | 物联网卡的IP地址。 |
VsimCardInfo | Object | 物联网卡的详情。 当查询多网卡时,展示虚拟卡信息。 |
|
Status | String | 35 | 物联网卡状态。
|
DataType | String | sameflowcard | 流量类型。
|
CardLimitSpeedThreshold | Integer | 1024 | 物联网卡达量限速阈值,单位为KB。(暂不支持) |
PeriodRestFlow | String | 130.00MB | 周期剩余流量。 |
DirectionalGroupName | String | 测试分组 | 定向分组名称。 |
CredentialType | String | CT-SC-M-1-30M | 套餐凭证类型。
|
PeriodAddFlow | String | 0KB | 周期累计流量。 |
DirectionalGroupId | String | 22 | 定向分组ID。 |
PeriodSmsUse | String | 0 | 周期短信用量。 |
OsStatus | String | 200 | 物联网卡的具体状态。
|
NotifyId | String | 11111 | 自动化规则的通知ID。 |
DataLevel | String | 30MB | 流量包档位。 |
TagList | Array of tagDto | 物联网卡的标签。 |
|
TagName | String | 测试标签 | 标签名称。 |
Id | Long | 24 | 标签ID。 |
AliyunOrderId | String | 211519634****** | 物联网卡关联的订单编号。 |
AliFee | String | ali_2 | 资费版本。 |
ActiveType | String | first_data_record | 激活方式。
|
IsAutoRecharge | Boolean | true | 套餐是否自动续费。
|
AutoLimitResume | Boolean | true | 达量停用后,次月是否自动复用。
|
CredentialInstanceId | String | 2622*** | 凭证实例ID。 |
CredentialLimitSpeedThreshold | Integer | 1024 | 凭证达量限速阈值,单位为KB。(暂不支持)。 |
ExpireTime | String | 2022-04-30 23:59:59 | 套餐到期时间。 |
FlowThresholdUnit | String | KB | 阈值流量单位。 |
ApnName | String | cmiot | APN名称。 |
ActiveTime | String | 2021-11-16 16:35:50 | 激活时间。 |
CardLimitStopThreshold | Integer | 20480 | 物联网卡达量停用阈值,单位为KB。(暂不支持) |
Iccid | String | 89860321******15668 | 物联网卡的ICCID。 |
Vendor | String | CMCC | 运营商。
|
Period | String | 1101 | 套餐结算周期。
|
PrivateNetworkSegment | String | 1.*.3.* | 私网网段(定向卡)。 |
OpenAccountTime | String | 2021-11-29 16:12:14 | 开户时间。 |
CertifyType | String | enterprise | 认证方式。 enterprise:企业认证。 |
SimType | String | nano | SIM卡类型。
|
CertifyStatus | String | 2 | 实名认证状态。
|
DeviceImei | String | 11111111****** | 设备的IMEI号。 |
VsimInstanceId | Integer | 123456 | 物联网卡的InstanceId值。 |
AutoRebindReuse | Boolean | false | 自动换绑重用。
|
CredentialNo | String | CM-***-*-2-**M | 套餐凭证。 |
CredentialLimitStopThreshold | Integer | 20480 | 凭证达量停用阈值。 |
Imsi | Array of String | 460081937****** | 物联网卡的IMSI。 |
Msisdn | Array of String | 1440993****** | 物联网卡的MSISDN。 |
OpenSms | Boolean | true | 短信功能开通情况。
|
Ip | Array of String | 190.*.*.* | 物联网卡的IP地址。 |
示例
请求示例
http(s)://linkcard.aliyuncs.com/?Action=GetCardDetail
&Iccid=89860321******15668
&ShowPsim=false
&InstanceId=411****
&DestroyCard=false
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetCardDetailResponse>
<Code>200</Code>
<RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
<ErrorMessage>InstanceId cannot be empty.</ErrorMessage>
<Success>true</Success>
<LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>
<Data>
<ListPsimCards>
<Status>35</Status>
<PrivateNetworkSegment>*.2.*.4</PrivateNetworkSegment>
<OsStatus>300</OsStatus>
<CertifyStatus>2</CertifyStatus>
<ApnName>cmiot</ApnName>
<PeriodAddFlow>130.00MB</PeriodAddFlow>
<Iccid>89860321******15668</Iccid>
<Vendor>CMCC</Vendor>
<PeriodSmsUse>0</PeriodSmsUse>
<Imsi>460081937******</Imsi>
<Msisdn>1411111******</Msisdn>
<OpenSms>true</OpenSms>
<Ip>1.1.*.*</Ip>
</ListPsimCards>
<VsimCardInfo>
<Status>35</Status>
<DataType>sameflowcard</DataType>
<CardLimitSpeedThreshold>1024</CardLimitSpeedThreshold>
<PeriodRestFlow>130.00MB</PeriodRestFlow>
<DirectionalGroupName>测试分组</DirectionalGroupName>
<CredentialType>CT-SC-M-1-30M</CredentialType>
<PeriodAddFlow>0KB</PeriodAddFlow>
<DirectionalGroupId>22</DirectionalGroupId>
<PeriodSmsUse>0</PeriodSmsUse>
<OsStatus>200</OsStatus>
<NotifyId>11111</NotifyId>
<DataLevel>30MB</DataLevel>
<TagList>
<TagName>测试标签</TagName>
<Id>24</Id>
</TagList>
<AliyunOrderId>211519634******</AliyunOrderId>
<AliFee>ali_2</AliFee>
<ActiveType>first_data_record</ActiveType>
<IsAutoRecharge>true</IsAutoRecharge>
<AutoLimitResume>true</AutoLimitResume>
<CredentialInstanceId>2622***</CredentialInstanceId>
<CredentialLimitSpeedThreshold>1024</CredentialLimitSpeedThreshold>
<ExpireTime>2022-04-30 23:59:59</ExpireTime>
<FlowThresholdUnit>KB</FlowThresholdUnit>
<ApnName>cmiot</ApnName>
<ActiveTime>2021-11-16 16:35:50</ActiveTime>
<CardLimitStopThreshold>20480</CardLimitStopThreshold>
<Iccid>89860321******15668</Iccid>
<Vendor>CMCC</Vendor>
<Period>1101</Period>
<PrivateNetworkSegment>1.*.3.*</PrivateNetworkSegment>
<OpenAccountTime>2021-11-29 16:12:14</OpenAccountTime>
<CertifyType>enterprise</CertifyType>
<SimType>nano</SimType>
<CertifyStatus>2</CertifyStatus>
<DeviceImei>11111111******</DeviceImei>
<VsimInstanceId>123456</VsimInstanceId>
<AutoRebindReuse>false</AutoRebindReuse>
<CredentialNo>CM-***-*-2-**M</CredentialNo>
<CredentialLimitStopThreshold>20480</CredentialLimitStopThreshold>
<Imsi>460081937******</Imsi>
<Msisdn>1440993******</Msisdn>
<OpenSms>true</OpenSms>
<Ip>190.*.*.*</Ip>
</VsimCardInfo>
</Data>
</GetCardDetailResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Code" : "200",
"RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
"ErrorMessage" : "InstanceId cannot be empty.",
"Success" : true,
"LocalizedMessage" : "InstanceId cannot be empty.",
"Data" : {
"ListPsimCards" : [ {
"Status" : "35",
"PrivateNetworkSegment" : "*.2.*.4",
"OsStatus" : "300",
"CertifyStatus" : "2",
"ApnName" : "cmiot",
"PeriodAddFlow" : "130.00MB",
"Iccid" : "89860321******15668",
"Vendor" : "CMCC",
"PeriodSmsUse" : "0",
"Imsi" : [ "460081937******" ],
"Msisdn" : [ "1411111******" ],
"OpenSms" : true,
"Ip" : [ "1.1.*.*" ]
} ],
"VsimCardInfo" : {
"Status" : "35",
"DataType" : "sameflowcard",
"CardLimitSpeedThreshold" : 1024,
"PeriodRestFlow" : "130.00MB",
"DirectionalGroupName" : "测试分组",
"CredentialType" : "CT-SC-M-1-30M",
"PeriodAddFlow" : "0KB",
"DirectionalGroupId" : "22",
"PeriodSmsUse" : "0",
"OsStatus" : "200",
"NotifyId" : "11111",
"DataLevel" : "30MB",
"TagList" : [ {
"TagName" : "测试标签",
"Id" : 24
} ],
"AliyunOrderId" : "211519634******",
"AliFee" : "ali_2",
"ActiveType" : "first_data_record",
"IsAutoRecharge" : true,
"AutoLimitResume" : true,
"CredentialInstanceId" : "2622***",
"CredentialLimitSpeedThreshold" : 1024,
"ExpireTime" : "2022-04-30 23:59:59",
"FlowThresholdUnit" : "KB",
"ApnName" : "cmiot",
"ActiveTime" : "2021-11-16 16:35:50",
"CardLimitStopThreshold" : 20480,
"Iccid" : "89860321******15668",
"Vendor" : "CMCC",
"Period" : "1101",
"PrivateNetworkSegment" : "1.*.3.*",
"OpenAccountTime" : "2021-11-29 16:12:14",
"CertifyType" : "enterprise",
"SimType" : "nano",
"CertifyStatus" : "2",
"DeviceImei" : "11111111******",
"VsimInstanceId" : 123456,
"AutoRebindReuse" : false,
"CredentialNo" : "CM-***-*-2-**M",
"CredentialLimitStopThreshold" : 20480,
"Imsi" : [ "460081937******" ],
"Msisdn" : [ "1440993******" ],
"OpenSms" : true,
"Ip" : [ "190.*.*.*" ]
}
}
}