You need to enable JavaScript to run this app.
文档中心
配置审计

配置审计

复制全文
下载 pdf
规则模版
DescribeRuleTemplates - 查询规则模板详情
复制全文
下载 pdf
DescribeRuleTemplates - 查询规则模板详情

批量查询当前账号规则模板详情。

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String
是

DescribeRuleTemplates

要执行的操作,取值:DescribeRuleTemplates。

Version
String
是

2025-01-01

API的版本,取值:2025-01-01。

TemplateIds
Array of String
是

["rt-123456"]

规则模板 ID 列表

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
Templates
Array of Object

[{"TemplateId":"rt-123456","TemplateName":"example-template","RiskLevel":"Low","Description":"example description","Source":"Custom","Triggers":[{"TriggerType":"ConfigurationItemChange"}],"Parameters":[{"Name":"example-name","Description":"example description","AllowedValues":"["cn-beijing","cn-shanghai"]","DefaultValue":"cn-beijing","ValueType":"string","IsCompulsory":"true"}],"PolicyRule":"package volcengine.config\n\ncompliant if { input.ConfigurationItem.Region == "cn-beijing" }","Scope":{"ResourceTypes":["Volcengine::Ecs::Instance"]}}]

规则模板详情列表

请求示例

POST /?Action=DescribeRuleTemplates&Version=2025-01-01 HTTP/1.1
Host: config.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260518T164649Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260518/cn-beijing/config/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "TemplateIds": [
    "rt-123456"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202605181646490000000000000000",
        "Action": "DescribeRuleTemplates",
        "Version": "2025-01-01",
        "Service": "config",
        "Region": "cn-beijing"
    },
    "Result": {
        "Templates": [
            {
                "TemplateId": "rt-123456",
                "TemplateName": "example-template",
                "RiskLevel": "Low",
                "Description": "example description",
                "Source": "example",
                "Triggers": [
                    {
                        "TriggerType": "ConfigurationItemChange",
                        "MaximumExecutionFrequency": "TwentyFour_Hours"
                    }
                ],
                "Parameters": [
                    {
                        "Name": "example-name",
                        "Description": "example description",
                        "AllowedValues": "example",
                        "DefaultValue": "example",
                        "ValueType": "example",
                        "IsCompulsory": false
                    }
                ],
                "PolicyRule": "package rules\n\ndefault compliance_type = \"COMPLIANT\"",
                "Scope": {
                    "ResourceTypes": [
                        "Volcengine::Ecs::Instance"
                    ]
                }
            }
        ]
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。

最近更新时间:2026.07.10 14:52:20
这个页面对您有帮助吗?
有用
有用
无用
无用