全部产品
Search
文档中心

数据管理 DMS:ListEffectiveOrders - 查询有效订单列表

更新时间:Mar 28, 2024

查询有效订单列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListEffectiveOrdersList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

A8FE12AA-300D-5FDF-806F-C2CB99161F32
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrorMessagestring

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

UnknownError
ErrorCodestring

错误码。

UnknownError
OrderSummaryobject []

订单概览。

CommodityCodestring

DMS 的商品 Code。

  • dms_pre_public_intl(包年包月)

  • dms_post_public_intl(按量付费)

包年包月
CommodityTypestring

商品类型。

  • VersionType:管控模式
  • SensitiveDataProtection:敏感数据保护
VersionType
VersionTypestring

购买商品类型为管控模式时,有以下类型可选择:

  • stand:稳定变更
  • safety:安全协同
safety
TotalQuotainteger

订单列表中所有订单额度总和。

12
OrderListobject []

订单明细

OrderIdstring

订单 ID。

2190037****
BuyerIdstring

购买用户的 UID。

2698420314****
InstanceIdstring

购买商品的实例 ID。

rm-bp1xd1v866****
StartTimestring

实例的开始时间。

2022-10-24 00:00:00
EndTimestring

实例的到期时间。

2022-11-24 00:00:00
InsNumstring

已购买的管控模式或敏感数据的使用额度。

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"
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史