查询仪表板或者大屏列表 - ListResources
功能介绍
仪表板和大屏资源统一。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/resources/{resource_type}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目ID。获取方法请参见获取项目ID。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
resource_type |
是 |
String |
参数解释： 资源类型。 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释： 分页查询偏移量。 约束限制： 不涉及 取值范围： [0,1000] 默认取值： 0 |
|
limit |
否 |
Integer |
参数解释： 返回条目数。 约束限制： 不涉及 取值范围： [1,1000] 默认取值： 10 |
|
sort_key |
否 |
String |
参数解释： 排序字段。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
sort_dir |
否 |
String |
参数解释： 排序类型。 约束限制： 不涉及 取值范围：
默认取值： asc |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Workspace-Id |
是 |
String |
参数解释： 工作空间ID。获取方法请参见获取工作空间ID。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
参数解释： 总数。 取值范围： 不涉及 |
|
page_data |
Array of ResourceVO objects |
分页数据 |
请求示例
获取大屏资源列表。
GET https://{endpoint}/v1/0e****127d****6b7****95750da/resources/screen
响应示例
状态码：200
查询资源列表成功。
{
"count" : 1,
"page_data" : [ {
"id" : "e2xxxx66f-81bxxxxxx9c38-80xxx0fxx9c84",
"name" : "未命名大屏1",
"create_user_name" : "dat***ig***",
"create_date" : 1707215155901,
"update_user_name" : "dat***ig***",
"update_date" : 1707215155901,
"status" : 0
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询资源列表成功。 |
错误码
请参见错误码。
