创建场景,校验创建场景的信息。
如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见:通过选投策略配置,快速搭建推荐场景
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /v2/openapi/instances/[instanceId]/scenes HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
dryRun | Boolean | Query | 是 | false |
true 校验场景id是否存在 false 默认false,创建场景 |
instanceId | String | Path | 是 | airec-cn-o400whm78004 |
实例id |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | InternalServerError |
错误码 |
message | String | An internal server error occurred |
错误详情 |
requestId | String | 8F81A922-6C81-46D6-B78C-CC35E16B1691 |
请求id |
result | Struct |
返回详情结果 |
|
gmtCreate | String | 2020-04-23T06:08:48.000Z |
创建时间 |
gmtModified | String | 2020-04-23T06:08:48.000Z |
最后修改时间 |
sceneId | String | test |
场景id |
status | String | DRAFT |
DRAFT 唤醒,重新发布 PUBLISHING 发布 FROZEN 冻结 |
示例
请求示例
POST openapi/instances/{instanceId}/scenes?dryRun=false
正常返回示例
XML
格式
<sceneId>123</sceneId>
<sceneMeta>
<sceneName>sceneTest</sceneName>
<description>xxx</description>
</sceneMeta>
JSON
格式
{
"sceneId":"123",
"sceneMeta":{
"sceneName":"sceneTest",
"description":"xxx"
}
}
错误码
访问错误中心查看更多错误码。