调用RunServiceSchedule根据客户ID&IP基本信息，为终端设备最优调度空闲资源（实例设备/容器POD），并完成虚拟设备环境的初始化。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ens:RunServiceSchedule | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 应用 ID | 474bdef0-d149-4695-abfb-52912d9143f0 |
| Uuid | string | 是 | 设备 UUID | hdm_d4f1059a8e1afc0956bd71b497faa433 |
| ClientIp | string | 是 | 客户端的 IP 地址。 | 180.166.45.146 |
| ServiceAction | string | 是 | 调度服务操作。枚举类型，取值范围： 容器化场景：
裸金属/虚机场景：
| Start |
| PodConfigName | string | 否 | 无效参数 | android |
| PreLockedTimeout | integer | 否 | 锁定空闲设备的时间上限，单位秒，仅 ServiceAction=PreSchedule 有效。默认 300。 | 300 |
| Directorys | string | 否 | 需要挂载的用户数据文件的目录列表。必须是全路径，不支持'/../'，取值示例： ["/data/app01", "/data/user"]。 注意：输入的目录路径是虚拟设备"/data"目录的相对目录，即实际对应的虚拟设备路径为"/data/{输入路径}" | [\"/data/app01\", \"/data/user\"] |
| ServiceCommands | string | 否 | 容器服务命令列表。Json 数组格式的字符串。 | [{\"containerName\": \"android\", \"commands\":[\"cat /tmp/token.json\"] }, { \"commands\":[\"ls -l /data/data\"] }] |
| ScheduleStrategy | string | 否 | 设备调度策略。Json 格式的字符串。 | {\"selectLevel\": \"RegionId\", \"values\": [\"cn-chengdu-telecom-2\"] } |
返回参数
示例
正常返回示例
JSON格式
{
"CommandResults": {
"CommandResult": [
{
"Command": "ls -l /data",
"ContainerName": "android",
"ResultMsg": "success"
}
]
},
"Index": 1,
"InstanceId": "i-5qvji3mom4ec013dyygmtxlkj",
"InstanceIp": "172.16.246.11",
"InstancePort": 1024,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"RequestRepeated": "false",
"TcpPorts": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | - |
| 400 | NoPermission | Permission denied. | 没有足够的权限，请联系云账号管理员授予您相应权限。 |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
| 400 | InvalidParameter | The errorMessage is %s. Please check it again. | - |
| 400 | LimitExceeded.SecurityGroup | The number of securityGroup exceeds the limit. | - |
| 400 | ens.interface.error | An error occurred while calling the API. | - |
| 400 | CallInterface | Call Interface Happen Error. | 接口调用出错。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-12-26 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |