发送实时截图任务指令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:SendLiveSnapshotJobCommand |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
JobId | string | 是 | 截图任务 ID。 | ****a046-263c-3560-978a-fb287782**** |
Command | string | 是 | 操作指令:start,stop,restart。 枚举值:
| start |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | %s | - |
400 | InvalidParameter | %s | - |
400 | JobLimitExceeded | Job limit exceeded. | - |
400 | StreamNotFound | No such stream. | - |
403 | UserDisable | User is disable. | - |
403 | Forbidden | User not authorized to operate on the specified resource. | 无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。) |
403 | OperationDenied | Your account has not enabled the ICE service. | 账号未开通智能媒体生产服务。 |
404 | JobNotFound | No such job. | - |
409 | JobAlreadyStarted | Job is already started. | - |
500 | InternalError | The request processing has failed due to some unknown error. | 后台发生未知错误,请稍后重试或联系客服解决。 |
访问错误中心查看更多错误码。