查询当前租户的倾斜影像列表
功能介绍
根据过滤条件查询当前租户的倾斜影像基本信息列表。过滤条件有:影像名称、影像别名、影像上传起止时间、影像状态、影像描述、分页偏移量、每页显示条数,影像排序规则。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/real3d/folders/query_by_condition
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Integer |
偏移量,表示从第几条记录开始查询。 |
limit |
是 |
Integer |
每页显示条数。 |
condition |
否 |
FolderQueryCondition object |
查询条件。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
folder_name |
否 |
String |
倾斜影像名称。支持中文、英文、数字以及“_”、“-”、“.”字符,长度限制为[1, 100]。 |
folder_alias |
否 |
String |
倾斜影像别名。支持中文、英文、数字以及“_”、“-”、“.”字符,长度限制为[1, 100]。 |
folder_desc |
否 |
String |
倾斜影像描述。支持中文、英文、数字以及“_”、“-”、“.”字符,长度限制为[0, 255]。 |
from |
否 |
String |
倾斜影像上传起始时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 |
to |
否 |
String |
倾斜影像上传结束时间。格式为UTC标准时间:yyyy-MM-dd'T'HH:mm:ss'Z'。 |
status |
否 |
String |
倾斜影像状态。当前仅支持处理中(0)、已完成(1)、导入失败(2)。 |
order |
否 |
String |
倾斜影像排序规则。 当前仅支持影像名称正序(1)、影像名称倒序(-1)、影像别名正序(2)、影像别名倒序(-2)、影像上传日期正序(3)、影像上传日期倒序(-3)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
folder_code |
String |
倾斜影像的唯一标识。 |
folder_name |
String |
倾斜影像名称。 |
folder_alias |
String |
倾斜影像别名。 |
folder_desc |
String |
倾斜影像描述。 |
obs_endpoint |
String |
倾斜影像所在OBS的Endpoint。 |
obs_path |
String |
倾斜影像所在OBS的目录地址。 |
create_time |
String |
倾斜影像上传时间。 |
status |
Integer |
倾斜影像状态。
|
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
偏移量,表示从第几条数据开始查询。 |
limit |
Integer |
每页包含的查询记录数量。 |
total |
Integer |
符合查询条件的记录总数。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 |
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 |
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
请求示例
该请求分页查询当前租户的倾斜影像列表。
POST https://{Endpoint}/v1/real3d/folders/query_by_condition { "offset" : 0, "limit" : 10 }
响应示例
状态码: 200
请求成功。
{ "folders" : [ { "folder_code" : "16565875049557xxxx", "folder_name" : "xxxx", "folder_alias" : "xxxx", "folder_desc" : "xxxx", "obs_endpoint" : "obs.xxxx.myhuaweicloud.com", "obs_path" : "real3d/xxxxx/real-test", "create_time" : "2023-05-11 17:10:13.000", "status" : 1 }, { "folder_code" : "16558314669791xxxx", "folder_name" : "xxxx", "folder_alias" : "xxxx", "folder_desc" : "xxxx", "obs_endpoint" : "obs.xxxx.myhuaweicloud.com", "obs_path" : "real3d/xxxxxx/test-image-source", "create_time" : "2023-05-09 15:06:00.000", "status" : 1 } ], "page" : { "offset" : 0, "limit" : 10, "total" : 2 } }
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
非法请求。 |
500 |
服务内部错误。 |
错误码
请参见错误码。