文档首页> 云地图服务 KooMap> API参考> API> 卫星影像用量统计> 查询用量
更新时间：2024-05-17 GMT+08:00
查看PDF
分享

查询用量

功能介绍

您可以查询时空专属存储服务或卫星影像生产服务的用量统计。

  • 时空专属存储服务：统计导入的原始影像、矢量数据、生产资料和成果影像存储总量。

  • 卫星影像生产服务：统计L2、L3、L4、L5等级的成果影像存储用量、成功处理的次数。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/kmp-control/usages

表1 Query参数

参数

是否必选

参数类型

描述

usage_type

是

String

查询的用量类型。

  • DATA：时空专属存储服务占用空间大小。

  • TASK：成功处理的成果影像数据大小以及成功处理任务次数。

limit

否

Integer

分页大小。

最小值：1

最大值：100

缺省值：10

offset

否

Integer

偏移量，表示从第几条记录开始查询。

最小值：0

最大值：2147483647

缺省值：0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

租户Token，用于租户鉴权。该值由IAM接口获取。

最小长度：0

最大长度：5000

响应参数

状态码： 200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID，用于运维人员定位请求日志。
表4 响应Body参数

参数

参数类型

描述

data

Array of UsageInfo objects

用量信息列表。

page

Page object

分页信息。
表5 UsageInfo

参数

参数类型

描述

usage_measure_name

String

用量度量名称，通常与KooMap的计费项保持一致。当前支持以下用量度量名称：

  • 时空专属存储

  • 基础处理：色彩增强与粗纠正L2

  • 基础处理：色彩增强与精纠正L3

  • 基础处理：正射纠正L4

  • 基础处理：影像镶嵌L5

最小长度：0

最大长度：50

usage_unit_type

String

用量单位类型，表示单条用量单位所对应的类型。

  • 该值为“VOLUME”时表示用量单位是存储量。

  • 该值为“TIME”时表示用量单位是次数。

usage_type

String

用量类型。

  • 该值为“DATA”时表示时空专属存储服务对应的用量。

  • 该值为“TASK”时表示处理任务服务对应的用量。

domain_id

String

华为云IAM租户账号ID。

最小长度：32

最大长度：32

usage_subtype

String

用量子类型，用于区分同一用量类型下的多个子用量，目前usage_type为“TASK”时才需要设置该值。

  • L2：L2等级生产服务

  • L3：L3等级生产服务

  • L4：L4等级生产服务

  • L5：L5等级生产服务

最小长度：0

最大长度：20

usage

Float

租户当前的使用量数值。

capacity

Float

租户购买的套餐总量值，按需使用取值为0。

unit

String

用量的计量单位。

  • 当用量单位类型为“VOLUME”时，单位为存储量相关的单位，如：GB。

  • 当用量单位类型为“TIME”时，单位为“次”。

created_time

String

用量记录的创建时间。格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。

最小长度：20

最大长度：20

update_time

String

用量记录的更新时间。格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。

最小长度：20

最大长度：20
表6 Page

参数

参数类型

描述

offset

Integer

偏移量，表示从第几条数据开始查询。

limit

Integer

每页包含的查询记录数量。

total

Integer

符合查询条件的记录总数。

状态码： 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID，用于运维人员定位请求日志。
表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID，用于运维人员定位请求日志。
表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

查询存储空间的用量列表。

GET https://{Endpoint}/v1/kmp-control/usages?usage_type=DATA&limit=0&offset=10

响应示例

状态码： 200

请求成功。

{
  "data" : [ {
    "usage_measure_name" : "时空专属存储",
    "usage_type" : "DATA",
    "domain_id" : "abc123c55c3c4526b2ed7a0213bc9xxx",
    "usage_subtype" : null,
    "usage_unit_type" : "VOLUME",
    "capacity" : 0,
    "usage" : 0,
    "unit" : "GB",
    "created_time" : "2022-10-27T13:12:56Z",
    "update_time" : "2022-10-27T13:12:56Z"
  } ],
  "page" : {
    "offset" : 0,
    "limit" : 10,
    "total" : 1
  }
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

500

服务内部错误。

错误码

请参见错误码。

分享：

    相关文档

    相关产品