You need to enable JavaScript to run this app.
导航
更新配置项备注
最近更新时间:2024.01.31 15:19:59首次发布时间:2021.02.23 10:42:28

本接口支持通过指定应用和配置项来更新配置项备注。

请求说明

  • 接口名称:UpdateImageSettingComment
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=UpdateImageSettingComment&Version=2018-08-01
  • 请求频率限制:10 次/秒
  • 超时时间:5 秒

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

Body

参数类型是否必选描述

AppId

String

应用 ID

说明

您可以通过调用获取应用列表的方式获取所需的 AppId。

SettingId

String

配置项 ID

说明

您可以通过调用获取配置项列表的方式获取所需的配置项 ID。

CommentString更新后的配置项备注

返回参数

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageSettingComment&Version=2018-08-01
{
    "AppId": "179132",
    "SettingId": "S-6c040a73-7f60-44f7-b3d0-d13942dcc752",
    "Comment": "test"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageSettingComment",
        "Version": "2018-08-01",
	    	"Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
         
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
				"Action": "UpdateImageSettingComment",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

访问错误码获取详细信息。