更新场景数据回灌文件状态-UpdateSceneDataReplay
功能介绍
此接口用于修改场景数据回灌文件状态。场景数据回灌文件上传后,调用该接口修改"ready"字段为"true",完成场景数据回灌创建。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:simScenario:update
Write
-
-
-
-
URI
PATCH https://{hostURL}/v2/{project_id}/sim/sm/replays/{id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | Integer | A unique integer value identifying this replay uri. |
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| file | 否 | FileNestedSrlz object | 参数解释: 数据回灌文件信息。 约束限制: 不涉及 |
| format | 否 | String | 参数解释: 数据回灌文件格式,当前仅支持pblog格式。 约束限制: 不涉及。 取值范围: 当前仅支持"pblog" 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 数据回灌资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| id | Integer | 参数解释: 数据回灌ID。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
| created_at | Double | 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_at | Double | 参数解释: 更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| file | FileNestedSrlz object | 参数解释: 数据回灌文件信息。 约束限制: 不涉及 |
| format | String | 参数解释: 数据回灌文件格式,当前仅支持pblog格式。 约束限制: 不涉及。 取值范围: 当前仅支持"pblog" 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| url | String | 参数解释: 文件资源地址。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| sha256 | String | 参数解释: 文件SHA256值。 约束限制: 必须是有效的SHA256字符串,可以使用本地哈希工具计算文件的SHA256值。 取值范围: 不涉及。 默认取值: 不涉及 |
| created_at | Double | 参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| updated_at | Double | 参数解释: 更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| path | String | 参数解释: 文件在OBS桶中的路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| bucket | String | 参数解释: 文件所在OBS桶。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| filename | String | 参数解释: 场景文件名。 约束限制: 场景文件为OpenSCENARIO格式。 取值范围: 长度范围[0-255]。 默认取值: 不涉及 |
| ready | Boolean | 参数解释: 文件上传状态。 约束限制: 当前未使用该参数。 取值范围: · true:上传完成 · false:上传未完成 默认取值: 不涉及 |
请求示例
更新场景数据回灌文件状态
PATCH https://{endpoint}/v2/{project_id}/sim/sm/replays/{id}/
{
"file" : {
"ready" : true
}
} 响应示例
状态码:200
请求成功
{
"url" : "/v2/my_project_id/sim/sm/replays/1/",
"id" : 1,
"created_at" : 1.699954027366838E9,
"updated_at" : 1.699954027366882E9,
"file" : {
"url" : "/v2/my_project_id/sim/sm/replays/1/files/12788681a26229bf79dd74axxxx9c1e28510d450f47833c54109105c/",
"sha256" : "12788681a26229bf79dd74axxxx9c1e28510d450f47833c54109105c",
"created_at" : 1.699954027363056E9,
"updated_at" : 1.699954027363114E9,
"path" : "sim/ifiles/replay/12788681a26229bf79dd74axxxx9c1e28510d450f47833c54109105c.pblog",
"bucket" : "octopus-raw-54d37c8xxxx1ff4ee9772687bf",
"filename" : "test_pblog.pblog",
"ready" : true
},
"format" : "pblog"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
请参见错误码。