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