修改指定实例的属性信息,包括系统属性(SystemProperties)和设置(Settings)。在关机和开机状态下调用该接口时,接口行为如下:
关机状态下调用:
开机状态下调用:
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
|---|---|---|---|---|---|
| Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | UpdatePodProperty |
| Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2022-08-01 |
字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| product_id | string | 是 | 实例所归属的业务 ID |
| pod_id | string | 是 | 指定实例 ID |
| pod_settings | List<Settings> | 否 | 实例 Settings 属性列表;详细信息,参考 Settings 定义 |
pod_properties |
| 否 | 实例系统属性列表,非持久化,立即生效,重启实例后失效;详细信息,参考 System Properties 定义 |
| pod_persist_properties | List<SystemProperties> | 否 | 实例系统属性列表,持久化,立即生效,重启实例后持久化保存;详细信息,参考 System Properties 定义 |
通用返回参数,请参考 ResponseMetadata 结构说明。
POST https://open.volcengineapi.com?Action=UpdatePodProperty &Version=2022-08-01 &<通过header传入的公共请求参数> { "product_id":"1591495366954xxxxxx", "pod_id":"7294157141458xxxxxx", "pod_settings": [ { "settings_type":"global", "settings_name":"locale_language", "settings_value":"en-US", "settings_value_type":"string" }, { "settings_type":"secure", "settings_name":"statusbar_switch", "settings_value":"on", "settings_value_type":"string" } ] }
{ "ResponseMetadata": { "Action": "UpdatePodProperty", "Region": "cn-north-1", "RequestId": "202310261939415A32F79E3C92B467809E", "Service": "ACEP", "Version": "2022-08-01" }, "Result": "success" }
| 错误码 | 说明 | 操作建议 |
|---|---|---|
| 8030010 | 所属业务欠费关停 | 确保业务下的资源订单按时充值付费 |
| 8060003 | 正在操作实例, 上次操作完成前禁止再次操作 | 等待操作完成后重试 |
8060005 | 操作的实例数量超过批量操作上限 | 参考说明文档,检查可批量执行的实例数量上限,建议减少并发请求 |
| 8060012 | 关机实例不能更新属性 | 实例已处于关机状态,不可执行操作 |