调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateRule	要执行的操作，取值：UpdateRule。
Version	String	是	2025-01-01	API的版本，取值：2025-01-01。
RuleName	String	是	example-rule	规则名称
Description	String	是	example description	描述
Triggers	Array of Object	是	[{"TriggerType":"ConfigurationItemChange","MaximumExecutionFrequency":"OneHour"}]	规则触发方式配置
InputParameters	String	是	{"allowedRegions":["cn-beijing"]}	规则运行时参数，JSON 字符串
Scope	Object	是	{"ResourceTypes":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"ResourceIds":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"Regions":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"Projects":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"Tags":{"Include":[{"Key":{},"Value":{}}],"Exclude":[{"Key":{},"Value":{}}]}}	资源评估范围
RiskLevel	String	是	Low	风险等级，可选值：Low,Medium,High
RuleId	String	是	rule-123456	规则 ID
Effect	String	否	Audit	规则执行效果，可选值：Audit,Modify；不传时默认 Audit
RemediationTriggerTypes	Array of String	否	["Manual","Auto"]	Modify 规则允许创建修正任务的触发方式，可选 Manual、Auto；不传时保持默认 Manual，Audit 规则不生效。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=UpdateRule&Version=2025-01-01 HTTP/1.1
Host: config.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260629T093000Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=<Credential>/20260629/cn-beijing/config/request, SignedHeaders=host;x-content-sha256;x-date, Signature=<Signature>

{
  "RuleId": "rule-123456",
  "RuleName": "example-rule",
  "Description": "example description",
  "Triggers": [
    {
      "TriggerType": "ConfigurationItemChange",
      "MaximumExecutionFrequency": "OneHour"
    }
  ],
  "InputParameters": "{\"allowedRegions\":[\"cn-beijing\"]}",
  "Scope": {
    "ResourceTypes": {
      "Include": [
        "Volcengine::Ecs::Instance"
      ]
    }
  },
  "RiskLevel": "Low",
  "Effect": "Modify",
  "RemediationTriggerTypes": [
    "Manual",
    "Auto"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202606291730000000000000000000",
    "Action": "UpdateRule",
    "Version": "2025-01-01",
    "Service": "config",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.
400	ServiceNotEnabled	The operation are prohibited when service is not enabled.	服务处于非开启状态时，禁止执行该操作
400	ConcurrentException	The operations frequency exceeds limit, please retry later.
400	NotFound.Rule	The rule is not found.
400	InvalidParameter.RemediationTriggerTypes	The specified parameter [RemediationTriggerTypes] is invalid.	修正触发方式不合法，或与规则执行效果不匹配。
500	InternalError	The request has failed due to an unknown error.

最近更新时间：2026.07.10 14:52:23

这个页面对您有帮助吗？

有用

无用

配置审计

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码