查询卫星影像基本信息
功能介绍
根据过滤条件查询卫星影像信息列表。过滤条件有：影像名称、上传日期、影像别名、影像等级、影像状态、是否为成果数据、分页偏移量、每页显示条数。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/kmp-data/imageinfo
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token信息，用于租户鉴权，该字段由租户请求IAM的Token接口获得。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
image_name |
否 |
String |
卫星影像名称，支持模糊查询。 格式为中英文、数字、下划线、中划线、“.”，长度100个字符以内。 最小长度：0 最大长度：100 |
image_date_from |
否 |
String |
卫星影像上传起始时间。 格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度：20 最大长度：20 |
image_date_to |
否 |
String |
卫星影像上传截止时间。 格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度：20 最大长度：20 |
image_status |
否 |
String |
卫星影像迁移状态列表。 当前仅支持完成（0）、迁入中（1）、迁入失败（2）、迁出中（3）、迁出失败（4）、删除中（6）、卫星影像正在被任务使用导致删除失败（7）、网络错误导致删除失败（8）。状态之间以“,”隔开。 |
raw_alias |
否 |
String |
卫星影像别名。 支持模糊查询，格式为中英文、数字、下划线、中划线、“.”，长度100个字符以内。 最小长度：0 最大长度：100 |
image_alias |
否 |
String |
卫星影像别名列表。 格式为中英文、数字、下划线、中划线、“.”。别名之间以“,”隔开。 |
image_levels |
否 |
String |
卫星影像等级列表。 当前仅支持L1、L1A、L1B、L2、L3、L4、L5。等级之间以“,”隔开。 |
is_product |
否 |
String |
卫星影像是否为成果数据。 当前仅支持原始数据（0）、成果数据（1）。 |
order |
否 |
String |
卫星影像排序规则。 当前仅支持影像名称正序（1）、影像名称倒序（-1）、影像别名正序（2）、影像别名倒序（-2）、影像上传日期正序（3）、影像上传日期倒序（-3）。 |
description |
否 |
String |
卫星影像描述。 格式为中英文、数字、下划线、中划线，长度为255个字符以内。 |
image_type |
否 |
String |
卫星影像类型。当前仅支持全色（0）、多光谱（1）。 |
limit |
是 |
Integer |
每页显示条数。 最小值：1 最大值：100 |
offset |
是 |
Integer |
偏移量，表示从第几条记录开始查询。 最小值：0 最大值：2147483647 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
image_name |
String |
卫星影像名称。 支持模糊查询，格式为中英文、数字、下划线、中划线、“.”，长度100个字符以内。 |
is_product |
String |
卫星影像是否为成果影像。 目前只支持原始影像（0）、成果影像（1）。 枚举值：
|
image_level |
String |
卫星影像等级。 目前只支持L1、L1A、L1B、L2、L3、L4、L5。 最小长度：2 最大长度：3 |
image_status |
String |
卫星影像迁移状态。当前仅支持完成（0）、迁入中（1）、迁入失败（2）、迁出中（3）、迁出失败（4）、删除中（6）、卫星影像正在被任务使用导致删除失败（7）、网络错误导致删除失败（8）。 |
image_date |
String |
卫星影像成像时间。 格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度：20 最大长度：20 |
upload_date |
String |
卫星影像上传时间。 格式为UTC标准时间：yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度：20 最大长度：20 |
image_resolution |
String |
卫星影像分辨率，精确到小数点后一位。 |
image_description |
String |
卫星影像描述。 格式为中英文、数字、下划线、中划线，长度255个字符以内。 最小长度：0 最大长度：255 |
image_id |
String |
卫星影像ID。 格式为英文、数字，长度为32。 最小长度：32 最大长度：32 |
image_type |
String |
卫星影像类型。当前仅支持全色（0）、多光谱（1）。 枚举值：
|
user_name |
String |
IAM用户名称。 |
image_alias |
String |
卫星影像别名。 格式为中英文、数字、下划线、中划线、“.”，长度255个字符以内。 最小长度：0 最大长度：255 |
product_clip |
Integer |
是否为矢量切割影像。当前仅支持是（1）、否（0）。 枚举值：
|
product_tile |
Integer |
是否为金字塔切割影像。当前仅支持是（1）、否（0）。 枚举值：
|
is_cog |
Integer |
是否为COG影像。当前仅支持是（1）、否（0）。 枚举值：
|
参数 |
参数类型 |
描述 |
|---|---|---|
offset |
Integer |
偏移量，表示从第几条数据开始查询。 |
limit |
Integer |
每页包含的查询记录数量。 |
total |
Integer |
符合查询条件的记录总数。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 |
error_msg |
String |
错误描述。 最小长度：2 最大长度：512 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-id |
String |
请求ID，用于运维人员定位请求日志。 |
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。格式为：KMP.XXXXXXXX，其中X表示数字。 最小长度：12 最大长度：12 |
error_msg |
String |
错误描述。 最小长度：2 最大长度：512 |
请求示例
查询卫星影像信息。参数需要以formData的形式组织。
POST https://{Endpoint}/v1/kmp-data/imageinfo
limit: "10"
offset: "0"
is_product: "0"
image_levels: "L1,L1A,L1B"
is_product:“0”
响应示例
状态码： 200
请求成功。
{
"data_info" : [ {
"image_name" : "影像名称",
"is_product" : "0",
"image_level" : "L1A",
"image_status" : "完成",
"image_date" : "2013-10-09T16:00:00Z",
"upload_date" : "2022-11-09T03:02:52Z",
"image_resolution" : "16.0",
"image_description" : "",
"image_id" : "9260ad8d63f84ed1a9269f56162e42a5",
"image_type" : "1",
"user_name" : "IAM用户名称",
"image_alias" : "WFV3",
"product_clip" : 1,
"product_tile" : 1,
"is_cog" : 1
} ]
}
状态码： 400
非法请求。
{
"error_code" : "400",
"error_msg" : "参数不符合规范。"
}
状态码
状态码 |
描述 |
|---|---|
200 |
请求成功。 |
400 |
非法请求。 |
500 |
服务内部错误。 |
错误码
请参见错误码。
