批量发布大屏
功能介绍
批量发布大屏。
URI
POST /v1/{project_id}/screens/batch-publish
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目唯一标识ID,获取方法请参考获取项目ID。 约束限制: 不涉及 取值范围: 只能使用中英文字符,字符长度32位。 默认取值: 不涉及 最小长度:0 最大长度:128 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Workspace-Id |
是 |
String |
参数解释: 工作空间ID,即控制台的项目ID。 约束限制: 不涉及 取值范围: 只能使用中英文字符,字符长度32位。 默认取值: 不涉及 最小长度:0 最大长度:128 |
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token 认证鉴权。 约束限制: 不涉及 取值范围: 非空。 默认取值: 不涉及 最小长度:0 最大长度:8192 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ids |
是 |
Array of strings |
参数解释: 执行批量操作大屏ID列表。 约束限制: 不涉及 取值范围: 字符串列表,大小限制为1~1000。 默认取值: 不涉及 最小长度:0 最大长度:120 数组长度:1 - 128 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
Boolean |
是否成功。 true, false |
请求示例
批量发布大屏。
https://{endpoint}/v1/{project_id}/screens/batch-publish { "ids" : [ "00xxxx3e-45e5-4cc3-847c-dcxxxx42424d" ] }
响应示例
状态码: 200
大屏发布成功。
{ "data" : true }
状态码
状态码 |
描述 |
---|---|
200 |
大屏发布成功。 |
错误码
请参见错误码。