批量查询当前账号规则详情。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeRules | 要执行的操作,取值:DescribeRules。 |
Version | String | 是 | 2025-01-01 | API的版本,取值:2025-01-01。 |
RuleIds | Array of String | 是 | ["rule-123456"] | 规则 ID 列表 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Rules | Array of Object | [{"RuleId":"rule-123456","RuleName":"example-rule","Description":"example description","RuleStatus":"Enabled","RiskLevel":"Low","CreatedTime":"2026-05-18T16:46:49Z","InputParameters":"{"allowedRegions":["cn-beijing"]}","Scope":{"ResourceTypes":{"Include":[],"Exclude":[]},"ResourceIds":{"Include":[],"Exclude":[]},"Regions":{"Include":[],"Exclude":[]},"Projects":{"Include":[],"Exclude":[]},"Tags":{"Include":[],"Exclude":[]}},"Triggers":[{"TriggerType":"ConfigurationItemChange","MaximumExecutionFrequency":"OneHour"}],"TemplateId":"rt-123456"}] | 规则详情列表 |
POST /?Action=DescribeRules&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 { "RuleIds": [ "rule-123456" ] }
{ "ResponseMetadata": { "RequestId": "202605181646490000000000000000", "Action": "DescribeRules", "Version": "2025-01-01", "Service": "config", "Region": "cn-beijing" }, "Result": { "Rules": [ { "RuleId": "rule-123456", "RuleName": "example-rule", "Description": "example description", "RuleStatus": "Enabled", "RiskLevel": "Low", "CreatedTime": "2026-05-18T16:46:49Z", "InputParameters": "{}", "Scope": { "ResourceTypes": [ "Volcengine::Ecs::Instance" ], "Regions": [ "cn-beijing" ] }, "Triggers": [ { "TriggerType": "ConfigurationItemChange", "MaximumExecutionFrequency": "TwentyFour_Hours" } ], "TemplateId": "rt-123456" } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | InvalidParameter | |
500 | InternalError |