创建数据场景片段-CreateDataScenarioSegment
功能介绍
创建数据场景片段
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataScenario:create
Write
workspace *
-
-
-
URI
POST /v1.0/{project_id}/data/scenario/segments
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| start | 是 | Long | 参数解释: 起始时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 1000000000000-2000000000000 默认取值: 不涉及 |
| end | 是 | Long | 参数解释: 结束时间,UTC标准时间毫秒时间戳 约束限制: 不涉及 取值范围: 1000000000000-2000000000000 默认取值: 不涉及 |
| dpk_id | 是 | String | 参数解释: 数据包ID 约束限制: 不涉及 取值范围: 以DPK开头,加7-13位数字 默认取值: 不涉及 |
| tag_ids | 是 | Array of integers | 参数解释: 标签ID列表,目前仅限一个标签,可通过“获取标签列表”获取 约束限制: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | payloadWithSingleString object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
请求示例
创建数据场景片段,对应数据包DPK0000001,打标签101
POST https://{endpoint}/v1.0/{project_id}/data/scenario/segments
{
"tag_ids" : [ 101 ],
"dpk_id" : "DPK0000001",
"start" : 1630057506742,
"end" : 1630057516742
} 响应示例
状态码:201
创建成功,返回场景片段id
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"item" : "3f6bf84a-dcfa-42b8-b39e-1331104ae1e7"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 创建成功,返回场景片段id |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 409 | 场景片段数量超过上限 |
| 500 | 系统内部错误 |
错误码
请参见错误码。