{
  "name": "config",
  "display_name": "配置审计",
  "description": "介绍如何使用API对配置审计进行操作，包括查询资源详情、查询相关资源、查询资源配置项等。",
  "domain": "other",
  "api_version": "2022-08-02",
  "endpoint": "config.tencentcloudapi.com",
  "actions": [
    {
      "name": "DescribeAggregateDiscoveredResource",
      "description": "账号组资源详情",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源ID",
          "example": "ins-sada"
        },
        {
          "name": "ResourceType",
          "type": "string",
          "required": true,
          "description": "资源类型",
          "example": "QCS::CVM::Instance"
        },
        {
          "name": "ResourceRegion",
          "type": "string",
          "required": true,
          "description": "资源地域",
          "example": "ap-hangzhou"
        },
        {
          "name": "AccountGroupId",
          "type": "string",
          "required": true,
          "description": "账号组ID",
          "example": "ca-sdfs7734h24h"
        },
        {
          "name": "ResourceOwnerId",
          "type": "integer",
          "required": true,
          "description": "资源所属用户ID",
          "example": "234234234"
        }
      ],
      "required": [
        "ResourceId",
        "ResourceType",
        "ResourceRegion",
        "AccountGroupId",
        "ResourceOwnerId"
      ]
    },
    {
      "name": "DescribeDiscoveredResource",
      "description": "资源详情",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源ID",
          "example": "ins-sada"
        },
        {
          "name": "ResourceType",
          "type": "string",
          "required": true,
          "description": "资源类型",
          "example": "QCS::CVM::Instance"
        },
        {
          "name": "ResourceRegion",
          "type": "string",
          "required": true,
          "description": "资源地域",
          "example": "ap-hangzhou"
        }
      ],
      "required": [
        "ResourceId",
        "ResourceType",
        "ResourceRegion"
      ]
    },
    {
      "name": "ListAggregateConfigRules",
      "description": "账号组获取规则列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "每页限制",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "1"
        },
        {
          "name": "AccountGroupId",
          "type": "string",
          "required": true,
          "description": "账号组ID",
          "example": "ca-sdfs7734h24h3"
        },
        {
          "name": "OrderType",
          "type": "string",
          "required": false,
          "description": "排序类型, 倒序：desc，顺序：asc",
          "example": "desc"
        },
        {
          "name": "RiskLevel",
          "type": "array",
          "required": false,
          "description": "风险等级 1：高风险。 2：中风险。 3：低风险。",
          "example": "[1,2]",
          "item_type": "integer"
        },
        {
          "name": "State",
          "type": "string",
          "required": false,
          "description": "规则状态",
          "example": "ACTIVE"
        },
        {
          "name": "ComplianceResult",
          "type": "array",
          "required": false,
          "description": "评估结果",
          "example": "[\"COMPLIANT\"]",
          "item_type": "string"
        },
        {
          "name": "RuleName",
          "type": "string",
          "required": false,
          "description": "规则名",
          "example": "规则1"
        },
        {
          "name": "RuleOwnerId",
          "type": "integer",
          "required": false,
          "description": "规则所属账号ID",
          "example": "98332222"
        }
      ],
      "required": [
        "Limit",
        "Offset",
        "AccountGroupId"
      ]
    },
    {
      "name": "ListAggregateDiscoveredResources",
      "description": "账号组获取资源列表",
      "status": "online",
      "parameters": [
        {
          "name": "MaxResults",
          "type": "integer",
          "required": true,
          "description": "每页显示数量",
          "example": "10"
        },
        {
          "name": "AccountGroupId",
          "type": "string",
          "required": true,
          "description": "账号组ID",
          "example": "ca-sdfs7734h24"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "resourceName：资源名 resourceId ：资源ID resourceType：资源类型",
          "example": "[     {         \"Values\": [             \"QCS::CVM::Instance\"         ],         \"Name\": \"resourceType\"     } ]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "查询字段名称 资源名称：resourceName 资源ID：resourceId 资源类型：resourceType 资源地域：resourceRegion 删除状态：resourceDelete 0未删除，1已删除 resourceRegionAndZone地域/可用区",
              "example": "resourceId"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "查询字段值",
              "example": "cvm17",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签",
          "example": "  [         {             \"TagKey\": \"TAG1\",             \"TagValue\": \"TAG3\"         }     ]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签key",
              "example": "产品部"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签value",
              "example": "运营部成员"
            }
          ]
        },
        {
          "name": "NextToken",
          "type": "string",
          "required": false,
          "description": "下一页token",
          "example": "E5WbfJQIT0Abtaj4RxODhsX"
        },
        {
          "name": "OrderType",
          "type": "string",
          "required": false,
          "description": "排序方式 asc、desc",
          "example": "desc"
        }
      ],
      "required": [
        "MaxResults",
        "AccountGroupId"
      ]
    },
    {
      "name": "ListConfigRules",
      "description": "获取规则列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "每页数量。 取值范围：1~200",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。 取值范围：最小值为0",
          "example": "1"
        },
        {
          "name": "OrderType",
          "type": "string",
          "required": false,
          "description": "排序类型(规则名称)。 倒序：desc， 顺序：asc",
          "example": "desc"
        },
        {
          "name": "RiskLevel",
          "type": "array",
          "required": false,
          "description": "风险等级。 1：高风险， 2：中风险， 3：低风险。",
          "example": "[1,2]",
          "item_type": "integer"
        },
        {
          "name": "State",
          "type": "string",
          "required": false,
          "description": "规则状态。 ACTIVE：启用 UN_ACTIVE：停用",
          "example": "ACTIVE"
        },
        {
          "name": "ComplianceResult",
          "type": "array",
          "required": false,
          "description": "评估结果。 COMPLIANT：合规 NON_COMPLIANT：不合规",
          "example": "[\"COMPLIANT\"]",
          "item_type": "string"
        },
        {
          "name": "RuleName",
          "type": "string",
          "required": false,
          "description": "规则名",
          "example": "规则1"
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "ListDiscoveredResources",
      "description": "获取资源列表",
      "status": "online",
      "parameters": [
        {
          "name": "MaxResults",
          "type": "integer",
          "required": true,
          "description": "每页显示数量",
          "example": "10"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "resourceName：资源名 resourceId ：资源ID",
          "example": "[]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": false,
              "description": "查询字段名称 资源名称：resourceName 资源ID：resourceId 资源类型：resourceType 资源地域：resourceRegion 删除状态：resourceDelete 0未删除，1已删除 resourceRegionAndZone地域/可用区",
              "example": "resourceId"
            },
            {
              "name": "Values",
              "type": "array",
              "required": false,
              "description": "查询字段值",
              "example": "cvm17",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签",
          "example": "[     {         \"tagKey\": \"运营部门\",         \"tagValue\": \"开发部     } ]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签key",
              "example": "产品部"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签value",
              "example": "运营部成员"
            }
          ]
        },
        {
          "name": "NextToken",
          "type": "string",
          "required": false,
          "description": "下一页token",
          "example": "C3IptlTj6hTlW0WKVO3NI"
        },
        {
          "name": "OrderType",
          "type": "string",
          "required": false,
          "description": "排序方式 asc、desc",
          "example": "desc"
        }
      ],
      "required": [
        "MaxResults"
      ]
    },
    {
      "name": "PutEvaluations",
      "description": "上报自定义规则评估结果",
      "status": "online",
      "parameters": [
        {
          "name": "ResultToken",
          "type": "string",
          "required": true,
          "description": "回调令牌。从自定义规则所选的scf云函数入参中取参数ResultToken值 云函数入参说明",
          "example": "FQikxW6AmU4cTUUpEJ-OF4Mvbq_7quPYZQOjDuo9cAxzUX-D8w=="
        },
        {
          "name": "Evaluations",
          "type": "array",
          "required": true,
          "description": "自定义规则评估结果信息。",
          "example": "[{         \"ComplianceResourceId\": \"disk-26itbqha\",         \"ComplianceResourceType\": \"QCS::CBS::Disk\",         \"ComplianceRegion\": \"ap-guangzhou\",         \"ComplianceType\": \"NON_COMPLIANT\",         \"Annotation\":              {                 \"Configuration\": \"1\",                 \"DesiredValue\": \"2\",                 \"Operator\": \"equal\",                 \"Property\": \"age\"             }       }]",
          "item_type": "object",
          "children": [
            {
              "name": "ComplianceResourceId",
              "type": "string",
              "required": true,
              "description": "已评估资源ID。长度为0~256个字符",
              "example": "disk-26itbqha"
            },
            {
              "name": "ComplianceResourceType",
              "type": "string",
              "required": true,
              "description": "已评估资源类型。 支持: QCS::CVM::Instance、 QCS::CBS::Disk、QCS::VPC::Vpc、QCS::VPC::Subnet、QCS::VPC::SecurityGroup、 QCS::CAM::User、QCS::CAM::Group、QCS::CAM::Policy、QCS::CAM::Role、QCS::COS::Bucket",
              "example": "QCS::CBS::Disk"
            },
            {
              "name": "ComplianceRegion",
              "type": "string",
              "required": true,
              "description": "已评估资源地域。 长度为0~32个字符",
              "example": "ap-guangzhou"
            },
            {
              "name": "ComplianceType",
              "type": "string",
              "required": true,
              "description": "合规类型。取值： COMPLIANT：合规、 NON_COMPLIANT：不合规",
              "example": "NON_COMPLIANT"
            },
            {
              "name": "Annotation",
              "type": "object",
              "required": false,
              "description": "不合规资源的补充信息。",
              "example": "无",
              "children": [
                {
                  "name": "Configuration",
                  "type": "string",
                  "required": true,
                  "description": "资源当前实际配置。长度为0~256位字符，即资源不合规配置",
                  "example": "10"
                },
                {
                  "name": "DesiredValue",
                  "type": "string",
                  "required": true,
                  "description": "资源期望配置。长度为0~256位字符，即资源合规配置",
                  "example": "12"
                },
                {
                  "name": "Operator",
                  "type": "string",
                  "required": false,
                  "description": "资源当前配置和期望配置之间的比较运算符。长度为0~16位字符，自定义规则上报评估结果此字段可能为空",
                  "example": "Equals"
                },
                {
                  "name": "Property",
                  "type": "string",
                  "required": false,
                  "description": "当前配置在资源属性结构体中的JSON路径。长度为0~256位字符，自定义规则上报评估结果此字段可能为空",
                  "example": "$.Cpu"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "ResultToken",
        "Evaluations"
      ]
    }
  ]
}