卡的套餐续订和叠加包订购，仅适用于单卡套餐和同档位池套餐（统付池套餐请通过控制台进行扩池和购功能费）。

使用限制

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

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

调试

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

请求参数

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

系统规定参数。取值：Renew。
ApiProduct String 否 linkcard

接口Code。
ApiRevision String 否 2021-05-20

接口版本。
Iccid String 是 89860321******15668

物联网卡的ICCID。

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

充值类型。

  • STANDARD：续订套餐。
  • OVERLAY ：订购叠加包。
SerialNo String 是 12345678

自定义的订单编号，编号需唯一且保持幂等性。

如果您的充值，涉及自有平台的订单管理，如给下游客户充值等，您可填入自有平台已生成的外部订单编号，该接口调用成功后，会生成一个订单编号（OrderNo）。该参数可以方便您将生成的订单编号与外部订单号关联起来。如果非此场景，你可填入任意正整数，例如0。
OfferCode String 否 COM***0203

充值类型为订购叠加包时需填写。

具体Code请咨询技术对接人员。
BuyNum Integer 是 12

订购份数。根据物联网卡本身的套餐类型选择订购份数。

  • 续订月套餐：支持1、2、3、6、9、12。
  • 续订年套餐：支持1、2、3。
  • 订购叠加包：支持1、2、3。

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

返回数据

名称 类型 示例值 描述
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

请求ID，阿里云为该请求生成的标识符。
Code String 200

接口返回码。

  • 200：表示成功。
  • 其它：表示错误码。错误码详情，请参见错误码。
ErrorMessage String 系统异常

调用失败时，返回的错误信息。
LocalizedMessage String InstanceId cannot be empty.

根据当前所在地展示对应语言的错误提示。
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。
Data Object

返回的订单编号数据。
OrderNo String 21450******0275

接口调用成功后生成的订单编号。
SerialNo String 12345678

自定义的订单编号（SerialNo）。

示例

请求示例

http(s)://linkcard.aliyuncs.com/?Action=Renew
&ApiProduct=linkcard
&ApiRevision=2021-05-20
&Iccid=89860321******15668
&RechargeType=STANDARD
&SerialNo=12345678
&OfferCode=COM***0203
&BuyNum=12
&公共请求参数

正常返回示例

XML格式

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

<RenewResponse>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <Code>200</Code>
    <Success>true</Success>
    <Data>
        <OrderNo>21450******0275</OrderNo>
        <SerialNo>12345678</SerialNo>
    </Data>
</RenewResponse>

JSON格式

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

{
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "Code" : "200",
  "Success" : true,
  "Data" : {
    "OrderNo" : "21450******0275",
    "SerialNo" : "12345678"
  }
}