创建场景库分类-CreateSceneLibraryCategory
功能介绍
创建场景库分类。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:simLogicalScenario:create
Write
-
-
-
-
URI
POST https://{hostURL}/v2/{project_id}/sim/sm/categories
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 场景库分类名称。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-64]个字符。 默认取值: 不涉及 |
| parent | 否 | String | 参数解释: 父级场景库分类资源地址。 约束限制: 父资源必须已经存在。 取值范围: 只能是url。 默认取值: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 场景库分类资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| id | Integer | 参数解释: 场景库分类ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| created_at | Double | 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_at | Double | 参数解释: 更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| parent_id | String | 参数解释: 父级场景分类ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| count | String | 参数解释: 子场景库分类数量。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| name | String | 参数解释: 场景库分类名称。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-64]个字符。 默认取值: 不涉及 |
| parent | String | 参数解释: 父级场景库分类资源地址。 约束限制: 父资源必须已经存在。 取值范围: 只能是url。 默认取值: 不涉及 |
请求示例
创建场景库分类
POST https://{endpoint}/v2/{project_id}/sim/sm/categories/
{
"name" : "my-category",
"parent" : null
} 响应示例
状态码:201
请求成功
{
"url" : "/v2/my_project_id/sim/sm/categories/361/",
"id" : 361,
"created_at" : 1.699954029362022E9,
"updated_at" : 1.699954029362044E9,
"parent_id" : 0,
"count" : 0,
"name" : "my-category",
"parent" : null
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 请求成功 |
错误码
请参见错误码。