该接口用于设置卡的达量停用规则。卡的月流量达到设定的数值时，卡将自动停用，可主动复用，仅支持同档位池套餐和统付池套餐。

使用限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为20。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SetCardStopRule

系统规定参数。取值：SetCardStopRule。

Iccid String 是 89860321******15668

物联网卡的ICCID。

您可在物联网卡上查看ICCID，或者在物联网SIM服务控制台的卡管理页面查看ICCID。

FlowLimit Long 是 100

达量停用的数值，仅支持正整数，单位：MB。

当月流量达到此数值时将自动停用，可主动复用。
AutoRestore Boolean 是 true

达量停用后，次月是否自动复用。

  • true（默认值）：次月自动复用。
  • false：次月不自动复用。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Data Boolean true

执行结果。

  • true：执行成功。
  • false：执行失败。
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

请求ID，阿里云为该请求生成的唯一标识符。
ErrorMessage String 系统异常

调用失败时，返回的错误信息。
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。
LocalizedMessage String InstanceId cannot be empty.

根据当前所在地展示对应语言的错误提示。
Code String 200

接口返回码。

  • 200：表示成功。
  • 其它：表示错误码。错误码详情，请参见错误码。

示例

请求示例

http(s)://linkcard.aliyuncs.com/?Action=SetCardStopRule
&Iccid=89860321******15668
&FlowLimit=100
&AutoRestore=true
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<SetCardStopRuleResponse>
    <Data>true</Data>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <Success>true</Success>
    <Code>200</Code>
</SetCardStopRuleResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : true,
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "Success" : true,
  "Code" : "200"
}