查询有效订单列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:ListEffectiveOrders |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Tid |
integer |
否 |
租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。 |
3*** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
A8FE12AA-300D-5FDF-806F-C2CB99161F32 |
| Success |
boolean |
请求是否成功，返回值如下：
|
true |
| ErrorMessage |
string |
调用失败时，返回的错误信息。 |
UnknownError |
| ErrorCode |
string |
错误码。 |
UnknownError |
| OrderSummary |
array<object> |
订单概览。 |
|
|
array<object> |
|||
| CommodityCode |
string |
DMS 的商品 Code。
|
包年包月 |
| CommodityType |
string |
商品类型。
|
VersionType |
| VersionType |
string |
购买商品类型为管控模式时，有以下类型可选择：
|
safety |
| TotalQuota |
integer |
订单列表中所有订单额度总和。 |
12 |
| OrderList |
array<object> |
订单明细 |
|
|
object |
订单 |
||
| OrderId |
string |
订单 ID。 |
2190037**** |
| BuyerId |
string |
购买用户的 UID。 |
2698420314**** |
| InstanceId |
string |
购买商品的实例 ID。 |
rm-bp1xd1v866**** |
| StartTime |
string |
实例的开始时间。 |
2022-10-24 00:00:00 |
| EndTime |
string |
实例的到期时间。 |
2022-11-24 00:00:00 |
| InsNum |
string |
已购买的管控模式或敏感数据的使用额度。 |
7 |
示例
正常返回示例
JSON格式
{
"RequestId": "A8FE12AA-300D-5FDF-806F-C2CB99161F32",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"OrderSummary": [
{
"CommodityCode": "包年包月",
"CommodityType": "VersionType",
"VersionType": "safety",
"TotalQuota": 12,
"OrderList": [
{
"OrderId": "2190037****",
"BuyerId": "2698420314****",
"InstanceId": "rm-bp1xd1v866****",
"StartTime": "2022-10-24 00:00:00",
"EndTime": "2022-11-24 00:00:00",
"InsNum": "7"
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。