查詢卡的詳情信息。
限制說明
單個阿里云賬號調用該接口的每秒請求數(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.*.*.*" ]
}
}
}