调用该接口获取云存储套餐的订单详情。

路径 /vision/customer/cloudstorage/order/get
版本号 1.0.5
协议 HTTP,HTTPS
请求方法 POST
是否需要用户身份鉴权 可选
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
iotId String QIuozfUcxRX6frOTO4dK**** 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
orderId String 20200731124115**** 购买云存储套餐的订单ID。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应的结果。

iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

identityId String

用户身份ID,生活物联网平台为每个注册用户颁发的用户身份标识符。

commodityCode String

云存储套餐编码。

specification String

云存储套餐规格。

copies Int

购买的数量。

price String

订单价格。

userName String

购买云存储套餐的用户名。

userId String

购买云存储套餐的用户ID。

orderId String

购买云存储套餐的订单ID。创建订单后根据该订单ID进行支付。

outOrderNo String

外部支付结算订单号。阿里云账号下的订单号。

status Int

云存储套餐订单的状态。0(订单有效,使用中);1(订单无效,已过期);2(订单冻结停用);3(创建中,未支付开通)。

paymentStatus Int

云存储订单支付状态。0(未支付);1(已支付);2(正在支付中)。

recordType Int

云存储录像类型,1(连续型);2(事件型)。

orderType Int

订单类型。0(付费订单);1(免费订单)。

startTime String

云存储套餐开始时间。如:2020-08-25 10:00:00。

endTime String

云存储套餐结束时间。如:2020-09-25 10:00:00。

startTimeUTC String

云存储套餐开始时间(UTC)。如:2020-08-25T02:00:00Z。

endTimeUTC String

云存储套餐结束时间(UTC)。如:2020-09-25T02:00:00Z。

示例

请求示例

// https://github.com/aliyun/iotx-api-gateway-client
IoTApiClientBuilderParams ioTApiClientBuilderParams = new IoTApiClientBuilderParams();

ioTApiClientBuilderParams.setAppKey("你的<AppKey>");
ioTApiClientBuilderParams.setAppSecret("你的<AppSecret>");

SyncApiClient syncApiClient = new SyncApiClient(ioTApiClientBuilderParams);

IoTApiRequest request = new IoTApiRequest();

// 设置请求ID
String uuid = UUID.randomUUID().toString();
String id = uuid.replace("-", "");
request.setId(id);
// 设置API版本号
request.setApiVer("1.0.5");

// 设置参数
request.putParam("iotId", "value0");
request.putParam("orderId", value1");
// 如果需要,设置headers
Map<String, String> headers = new HashMap<String, String>(8);
// headers.put("你的<header", "你的<value>");

// 设置请求参数域名, path, request, isHttps, headers
ApiResponse response = syncApiClient.postBody("api.link.aliyun.com", "/vision/customer/cloudstorage/order/get", request, true, headers);

System.out.println(
    "response code = " + response.getCode()
        + " response = " + new String(response.getBody(), "UTF-8")
        + " headers = " + response.getHeaders().toString()
);

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "iotId": "123",
        "identityId": "123",
        "commodityCode":"ilopLVCloudResource",
        "specification":"eventResource_7",
        "copies": 1,
        "price": "1.0",
        "userName": "123",
        "userId":"123",
        "orderId":"20200731124115****",
        "outOrderNo":"20670001970****",
        "status": 0,
        "paymentStatus": 1,
        "orderType":0,
        "recordType": 2,
        "startTime":"2020-08-25 10:00:0",
        "endTime":"2020-09-25 10:00:0",
        "startTimeUTC":"2020-08-25T02:00:00Z",
        "endTimeUTC":"2020-09-25T02:00:00Z"
    }
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 460,
    "message": "auth falied",
    "localizedMsg": "鉴权失败",
    "data": null
}