场景库分类列表
功能介绍
场景库分类列表。
URI
GET /v2/{project_id}/sim/sm/categories
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_root |
否 |
Boolean |
是否是根节点,true是根节点,false非根节点 |
|
name |
否 |
String |
名称,最大长度64位,支持中文,字母,数字及下划线命名 |
|
parent |
否 |
Integer |
父级ID |
|
limit |
否 |
Integer |
返回个数上限,最大值为100,默认值为10 |
|
offset |
否 |
Integer |
查询偏移量 |
|
ordering |
否 |
String |
查询结果的排序方式(默认升序,-为降序)
|
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
数量信息 |
|
next |
String |
下一页结果集资源地址 |
|
previous |
String |
上一页结果集资源地址 |
|
results |
Array of CategoriesListSrlz objects |
当前页结果集信息 |
请求示例
场景库分类列表
GET https://{endpoint}/v2/{project_id}/sim/sm/categories?offset=0&limit=10&is_root=true
响应示例
状态码:200
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"url": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/categories/45/",
"id": 45,
"created_at": 1744772710.859864,
"updated_at": 1744772710.859905,
"parent_id": 0,
"count": 2,
"name": "category-x1",
"parent": null
},
{
"url": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/categories/44/",
"id": 44,
"created_at": 1744708154.885394,
"updated_at": 1744708154.885428,
"parent_id": 0,
"count": 0,
"name": "categories-x2",
"parent": null
},
{
"url": "/v2/54d37c8f25af42xxxxx4ee9772687bf/sim/sm/categories/34/",
"id": 34,
"created_at": 1743125723.734035,
"updated_at": 1743125723.734062,
"parent_id": 0,
"count": 6,
"name": "category-x3",
"parent": null
}
]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
错误码
请参见错误码。