接口功能介绍
该接口提供用户立即执行云主机快照策略的功能，通过该接口可以立即对当前快照策略绑定的云主机执行快照
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1. 确保当前请求资源池下，该快照策略存在（即snapshotPolicyID真实存在且与regionID相对应）
2. 快照策略需要为启用状态，您可以通过查询云主机快照策略详情来查询当前快照策略查看返回值云主机快照策略状态（snapshotPolicyStatus）是否为启用状态（1）
3. 快照策略需要绑定云主机，并且绑定云主机需处于运行中（running）或关机（stopped）状态，您可以通过查询快照策略绑定云主机列表来查询当前快照策略是否绑定了云主机
URI
POST /v4/ecs/snapshot-policy/execute
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
| snapshotPolicyID | 是 | String | 云主机快照策略ID，32字节 获取： 查 查询云主机快照策略列表 创 创建云主机快照策略 |
4f69f096066011ee9caf0242ac110002 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| snapshotPolicyID | String | 执行的云主机快照策略ID | 4f69f096066011ee9caf0242ac110002 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"snapshotPolicyID": "4f69f096066011ee9caf0242ac110002"
}
响应示例
{
"returnObj": {
"snapshotPolicyID": "4f69f096066011ee9caf0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
