全部产品
云市场
云游戏

CreateScene

更新时间:2020-09-02 10:06:40

如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见:通过选投策略配置,快速搭建推荐场景

描述


创建场景,校验创建场景的信息。

方法


POST

URI

openapi/instances/{instanceId}/scenes

请求参数说明

参数 类型 是否必需 描述
dryRun boolean true 校验场景id是否存在
false 默认false,创建场景
sceneId String 填写
sceneMeta Map 场景信息
└sceneName String 场景名称
└description String 场景描述

返回参数

参数 类型 描述
RequestId String 当前请求的RequestID
Result Map 返回详情结果
└SceneId String 返回要创建的场景ID

示例

请求示例

  1. POST openapi/instances/{instanceId}/scenes?dryRun=false
  1. {
  2. "sceneId":"123",
  3. "sceneMeta":{
  4. "sceneName":"sceneTest",
  5. "description":"xxx"
  6. }
  7. }

正常返回示例

JSON 格式

  1. {
  2. "RequestId":"8F81A922-6C81-46D6-B78C-CC35E16B1691",
  3. "Result":{
  4. "SceneId": "xxxxx"
  5. }
  6. }

异常返回示例

JSON 格式

  1. {
  2. "Code":"InternalServerError",
  3. "Message":"An internal server error occurred.",
  4. "RequestId":"829F38F6-E2D6-4109-90A6-888160BD16C2"
  5. }