{
  "name": "cloudaudit",
  "display_name": "操作审计",
  "description": "介绍如何使用API对操作审计进行操作，包括更新跟踪集、检索日志、查询日志等。",
  "domain": "other",
  "api_version": "2019-03-19",
  "endpoint": "cloudaudit.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateAuditTrack",
      "description": "创建操作审计跟踪集",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "跟踪集名称，仅支持大小写字母、数字、-以及_的组合，3-48个字符",
          "example": "操作审计"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "跟踪集状态（未开启：0；开启：1）",
          "example": "1"
        },
        {
          "name": "Storage",
          "type": "object",
          "required": true,
          "description": "数据投递存储（目前支持 cos、cls 、ckafka）",
          "example": "无",
          "children": [
            {
              "name": "StorageType",
              "type": "string",
              "required": true,
              "description": "存储类型（目前支持 cos、cls、ckafka）",
              "example": "cos"
            },
            {
              "name": "StorageRegion",
              "type": "string",
              "required": true,
              "description": "存储所在地域",
              "example": "ap-shanghai"
            },
            {
              "name": "StorageName",
              "type": "string",
              "required": true,
              "description": "存储名称(cos：存储名称为用户自定义的存储桶名称，不包含\u0026quot;-APPID\u0026quot;，仅支持小写字母、数字以及中划线\u0026quot;-\u0026quot;的组合，不能超过50字符，且不支持中划线\u0026quot;-\u0026quot;开头或结尾； cls：存储名称为日志主题id，字符长度为1-50个字符； ckafka： ckafka实例ID/topic. 举例：ckafka-xxxxxx/tencent_test_audit_log)",
              "example": "audit"
            },
            {
              "name": "StoragePrefix",
              "type": "string",
              "required": true,
              "description": "存储目录前缀，cos日志文件前缀仅支持字母和数字的组合，3-40个字符",
              "example": "audit"
            },
            {
              "name": "StorageAccountId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户ID",
              "example": "23424"
            },
            {
              "name": "StorageAppId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户appid",
              "example": "3545646"
            },
            {
              "name": "Compress",
              "type": "integer",
              "required": false,
              "description": "是否压缩。1:压缩 2:不压缩",
              "example": "1"
            }
          ]
        },
        {
          "name": "ActionType",
          "type": "string",
          "required": true,
          "description": "跟踪事件类型（读：Read；写：Write；全部：*）",
          "example": "Read"
        },
        {
          "name": "ResourceType",
          "type": "string",
          "required": true,
          "description": "跟踪事件所属产品（支持全部产品或单个产品，如：cos，全部：*）",
          "example": "cos"
        },
        {
          "name": "EventNames",
          "type": "array",
          "required": true,
          "description": "跟踪事件接口名列表（ResourceType为 * 时，EventNames必须为全部：[\u0026quot;*\u0026quot;]；指定ResourceType时，支持全部接口：[\u0026quot;*\u0026quot;]；支持部分接口：[\u0026quot;cos\u0026quot;, \u0026quot;cls\u0026quot;]，接口列表上限10个）",
          "example": "[\"AddUser\"]",
          "item_type": "string"
        },
        {
          "name": "TrackForAllMembers",
          "type": "integer",
          "required": false,
          "description": "是否开启将集团成员操作日志投递到集团管理账号或者可信服务管理账号(0：未开启，1：开启，只能集团管理账号或者可信服务管理账号开启此项功能)",
          "example": "1"
        },
        {
          "name": "ExportId",
          "type": "string",
          "required": false,
          "description": "任务ID",
          "example": "20250707_163212_1hxWz5otqS7akePfoX1xlWem1AuUVUGP"
        }
      ],
      "required": [
        "Name",
        "Status",
        "Storage",
        "ActionType",
        "ResourceType",
        "EventNames"
      ]
    },
    {
      "name": "CreateEventsAuditTrack",
      "description": "创建操作审计跟踪集",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "跟踪集名称，仅支持大小写字母、数字、-以及_的组合，3-48个字符",
          "example": "audit_test"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "跟踪集状态（未开启：0；开启：1）",
          "example": "1"
        },
        {
          "name": "Storage",
          "type": "object",
          "required": true,
          "description": "数据投递存储（目前支持 cos、cls、ckafka）",
          "example": "无",
          "children": [
            {
              "name": "StorageType",
              "type": "string",
              "required": true,
              "description": "存储类型（目前支持 cos、cls、ckafka）",
              "example": "cos"
            },
            {
              "name": "StorageRegion",
              "type": "string",
              "required": true,
              "description": "存储所在地域",
              "example": "ap-shanghai"
            },
            {
              "name": "StorageName",
              "type": "string",
              "required": true,
              "description": "存储名称(cos：存储名称为用户自定义的存储桶名称，不包含\u0026quot;-APPID\u0026quot;，仅支持小写字母、数字以及中划线\u0026quot;-\u0026quot;的组合，不能超过50字符，且不支持中划线\u0026quot;-\u0026quot;开头或结尾； cls：存储名称为日志主题id，字符长度为1-50个字符； ckafka： ckafka实例ID/topic. 举例：ckafka-xxxxxx/tencent_test_audit_log)",
              "example": "audit"
            },
            {
              "name": "StoragePrefix",
              "type": "string",
              "required": true,
              "description": "存储目录前缀，cos日志文件前缀仅支持字母和数字的组合，3-40个字符",
              "example": "audit"
            },
            {
              "name": "StorageAccountId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户ID",
              "example": "23424"
            },
            {
              "name": "StorageAppId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户appid",
              "example": "3545646"
            },
            {
              "name": "Compress",
              "type": "integer",
              "required": false,
              "description": "是否压缩。1:压缩 2:不压缩",
              "example": "1"
            }
          ]
        },
        {
          "name": "Filters",
          "type": "object",
          "required": true,
          "description": "数据过滤条件",
          "example": "无",
          "children": [
            {
              "name": "ResourceFields",
              "type": "array",
              "required": false,
              "description": "资源筛选条件",
              "example": "[{\"ResourceType\":\"cam\",\"ActionType\":\"*\",\"EventNames\":[\"AddSubAccount\",\"AddSubAccountCheckingMFA\"]}]",
              "item_type": "object",
              "children": [
                {
                  "name": "ResourceType",
                  "type": "string",
                  "required": true,
                  "description": "跟踪事件所属产品（支持全部产品或单个产品，如：cam，全部：*）",
                  "example": "cvm"
                },
                {
                  "name": "ActionType",
                  "type": "string",
                  "required": true,
                  "description": "跟踪事件类型（读：Read；写：Write；全部：*）",
                  "example": "Read"
                },
                {
                  "name": "EventNames",
                  "type": "array",
                  "required": true,
                  "description": "跟踪事件接口名列表（ResourceType为 * 时，EventNames必须为全部：[\"\"]；指定ResourceType时，支持全部接口：[\"\"]；支持部分接口：[\"cos\", \"cls\"]，接口列表上限10个）",
                  "example": "[\"AddUser\"]",
                  "item_type": "string"
                }
              ]
            }
          ]
        },
        {
          "name": "TrackForAllMembers",
          "type": "integer",
          "required": false,
          "description": "是否开启将集团成员操作日志投递到集团管理账号或者可信服务管理账号(0：未开启，1：开启，只能集团管理账号或者可信服务管理账号开启此项功能)",
          "example": "1"
        }
      ],
      "required": [
        "Name",
        "Status",
        "Storage",
        "Filters"
      ]
    },
    {
      "name": "DeleteAuditTrack",
      "description": "删除操作审计跟踪集",
      "status": "online",
      "parameters": [
        {
          "name": "TrackId",
          "type": "integer",
          "required": true,
          "description": "跟踪集 ID",
          "example": "1"
        }
      ],
      "required": [
        "TrackId"
      ]
    },
    {
      "name": "DescribeAudit",
      "description": "查询跟踪集详情",
      "status": "online",
      "parameters": [
        {
          "name": "AuditName",
          "type": "string",
          "required": true,
          "description": "跟踪集名称",
          "example": "audit_log"
        }
      ],
      "required": [
        "AuditName"
      ]
    },
    {
      "name": "DescribeAuditTrack",
      "description": "查询操作审计跟踪集详情",
      "status": "online",
      "parameters": [
        {
          "name": "TrackId",
          "type": "integer",
          "required": true,
          "description": "跟踪集 ID",
          "example": "1"
        }
      ],
      "required": [
        "TrackId"
      ]
    },
    {
      "name": "DescribeAuditTracks",
      "description": "查询操作审计跟踪集列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageNumber",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "每页数目",
          "example": "10"
        }
      ],
      "required": [
        "PageNumber",
        "PageSize"
      ]
    },
    {
      "name": "DescribeEvents",
      "description": "查询操作审计日志",
      "status": "online",
      "parameters": [
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "起始时间戳（单位秒，不超过当前时间 90 天）",
          "example": "1612171581"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "结束时间戳（单位秒，查询时间跨度小于 30 天）",
          "example": "1612173581"
        },
        {
          "name": "NextToken",
          "type": "integer",
          "required": false,
          "description": "查看更多日志的凭证",
          "example": "123213213312313"
        },
        {
          "name": "MaxResults",
          "type": "integer",
          "required": false,
          "description": "返回日志的最大条数（最大 50 条）",
          "example": "10"
        },
        {
          "name": "LookupAttributes",
          "type": "array",
          "required": false,
          "description": "检索条件（目前支持： RequestId：请求 ID EventName：事件名称 ActionType：操作类型（Write：写；Read：读） PrincipalId：子账号 ResourceType：资源类型 ResourceId：资源Id ResourceName：资源名称 AccessKeyId：密钥 ID SensitiveAction：是否敏感操作 ApiErrorCode：API 错误码 CamErrorCode：CAM 错误码 SourceIPAddress：请求IP Tags：标签（AttributeValue格式：[{\"key\":\"*\",\"value\":\"*\"}]） 备注:检索的各个条件间是与的关系,Eve...",
          "example": "[{\"AttributeKey:XX,\"AttributeValue\":xx}]",
          "item_type": "object",
          "children": [
            {
              "name": "AttributeKey",
              "type": "string",
              "required": true,
              "description": "AttributeKey的有效取值范围是:RequestId、EventName、ActionType、PrincipalId、ResourceId、ResourceName、AccessKeyId、SensitiveAction、ApiErrorCode、CamErrorCode、SourceIPAddress、Tags",
              "example": "EventName"
            },
            {
              "name": "AttributeValue",
              "type": "string",
              "required": false,
              "description": "AttributeValue的值",
              "example": "ConsoleLogin"
            }
          ]
        },
        {
          "name": "IsReturnLocation",
          "type": "integer",
          "required": false,
          "description": "是否返回 IP 归属地（1 返回，0 不返回）",
          "example": "1"
        }
      ],
      "required": [
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "GetAttributeKey",
      "description": "查询AttributeKey的有效取值范围",
      "status": "online",
      "parameters": [
        {
          "name": "WebsiteType",
          "type": "string",
          "required": false,
          "description": "网站类型，取值范围是zh和en。如果不传值默认zh",
          "example": "ap-guangzhou"
        }
      ],
      "required": []
    },
    {
      "name": "InquireAuditCredit",
      "description": "查询用户可创建跟踪集的数量",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "ListAudits",
      "description": "查询跟踪集概要",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "ListCmqEnableRegion",
      "description": "查询操作审计支持的cmq的可用区",
      "status": "online",
      "parameters": [
        {
          "name": "WebsiteType",
          "type": "string",
          "required": false,
          "description": "站点类型。zh表示中国区，en表示国际区。默认中国区。",
          "example": "zh"
        }
      ],
      "required": []
    },
    {
      "name": "ListCosEnableRegion",
      "description": "查询操作审计支持的cos可用区",
      "status": "online",
      "parameters": [
        {
          "name": "WebsiteType",
          "type": "string",
          "required": false,
          "description": "站点类型。zh表示中国区，en表示国际区。默认中国区。",
          "example": "zh"
        }
      ],
      "required": []
    },
    {
      "name": "ListKeyAliasByRegion",
      "description": "根据地域获取KMS密钥别名",
      "status": "online",
      "parameters": [
        {
          "name": "KmsRegion",
          "type": "string",
          "required": true,
          "description": "Kms地域",
          "example": "ap-guangzhou"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。缺省值为10，最大值为200",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0",
          "example": "1"
        }
      ],
      "required": [
        "KmsRegion"
      ]
    },
    {
      "name": "LookUpEvents",
      "description": "用于对操作日志进行检索，便于用户进行查询相关的操作信息。",
      "status": "online",
      "parameters": [
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "开始时间",
          "example": "1553056487"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "结束时间",
          "example": "1553056687"
        },
        {
          "name": "LookupAttributes",
          "type": "array",
          "required": false,
          "description": "检索条件",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "AttributeKey",
              "type": "string",
              "required": true,
              "description": "AttributeKey的有效取值范围是:RequestId、EventName、ActionType、PrincipalId、ResourceId、ResourceName、AccessKeyId、SensitiveAction、ApiErrorCode、CamErrorCode、SourceIPAddress、Tags",
              "example": "EventName"
            },
            {
              "name": "AttributeValue",
              "type": "string",
              "required": false,
              "description": "AttributeValue的值",
              "example": "ConsoleLogin"
            }
          ]
        },
        {
          "name": "NextToken",
          "type": "string",
          "required": false,
          "description": "查看更多日志的凭证",
          "example": "79ba1f24-c21c-4858-a8e6-a9266b0599ff"
        },
        {
          "name": "MaxResults",
          "type": "integer",
          "required": false,
          "description": "返回日志的最大条数",
          "example": "10"
        },
        {
          "name": "Mode",
          "type": "string",
          "required": false,
          "description": "操作审计模式，有效值：standard | quick，其中standard是标准模式，quick是极速模式。默认为标准模式",
          "example": "standard "
        }
      ],
      "required": [
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "ModifyAuditTrack",
      "description": "修改操作审计跟踪集",
      "status": "online",
      "parameters": [
        {
          "name": "TrackId",
          "type": "integer",
          "required": true,
          "description": "跟踪集 ID",
          "example": "1"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "跟踪集名称，仅支持大小写字母、数字、-以及_的组合，3-48个字符",
          "example": "操作审计"
        },
        {
          "name": "ActionType",
          "type": "string",
          "required": false,
          "description": "跟踪事件类型（读：Read；写：Write；全部：*）",
          "example": "Read"
        },
        {
          "name": "ResourceType",
          "type": "string",
          "required": false,
          "description": "跟踪事件所属产品（支持全部产品或单个产品，如：cos，全部：*）",
          "example": "cos"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "跟踪集状态（未开启：0；开启：1）",
          "example": "1"
        },
        {
          "name": "EventNames",
          "type": "array",
          "required": false,
          "description": "跟踪事件接口名列表（ResourceType为 * 时，EventNames必须为全部：[\u0026quot;*\u0026quot;]；指定ResourceType时，支持全部接口：[\u0026quot;*\u0026quot;]；支持部分接口：[\u0026quot;cos\u0026quot;, \u0026quot;cls\u0026quot;]，接口列表上限10个）",
          "example": "[\"AddUser\"]",
          "item_type": "string"
        },
        {
          "name": "Storage",
          "type": "object",
          "required": false,
          "description": "数据投递存储（目前支持 cos、cls、ckafka）",
          "example": "无",
          "children": [
            {
              "name": "StorageType",
              "type": "string",
              "required": true,
              "description": "存储类型（目前支持 cos、cls、ckafka）",
              "example": "cos"
            },
            {
              "name": "StorageRegion",
              "type": "string",
              "required": true,
              "description": "存储所在地域",
              "example": "ap-shanghai"
            },
            {
              "name": "StorageName",
              "type": "string",
              "required": true,
              "description": "存储名称(cos：存储名称为用户自定义的存储桶名称，不包含\u0026quot;-APPID\u0026quot;，仅支持小写字母、数字以及中划线\u0026quot;-\u0026quot;的组合，不能超过50字符，且不支持中划线\u0026quot;-\u0026quot;开头或结尾； cls：存储名称为日志主题id，字符长度为1-50个字符； ckafka： ckafka实例ID/topic. 举例：ckafka-xxxxxx/tencent_test_audit_log)",
              "example": "audit"
            },
            {
              "name": "StoragePrefix",
              "type": "string",
              "required": true,
              "description": "存储目录前缀，cos日志文件前缀仅支持字母和数字的组合，3-40个字符",
              "example": "audit"
            },
            {
              "name": "StorageAccountId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户ID",
              "example": "23424"
            },
            {
              "name": "StorageAppId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户appid",
              "example": "3545646"
            },
            {
              "name": "Compress",
              "type": "integer",
              "required": false,
              "description": "是否压缩。1:压缩 2:不压缩",
              "example": "1"
            }
          ]
        },
        {
          "name": "TrackForAllMembers",
          "type": "integer",
          "required": false,
          "description": "是否开启将集团成员操作日志投递到集团管理账号或者可信服务管理账号(0：未开启，1：开启，只能集团管理账号或者可信服务管理账号开启此项功能)",
          "example": "1"
        }
      ],
      "required": [
        "TrackId"
      ]
    },
    {
      "name": "ModifyEventsAuditTrack",
      "description": "修改操作审计跟踪集",
      "status": "online",
      "parameters": [
        {
          "name": "TrackId",
          "type": "integer",
          "required": true,
          "description": "跟踪集 ID",
          "example": "1"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "跟踪集名称，仅支持大小写字母、数字、-以及_的组合，3-48个字符",
          "example": "audit_test"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "跟踪集状态（未开启：0；开启：1）",
          "example": "1"
        },
        {
          "name": "Storage",
          "type": "object",
          "required": false,
          "description": "数据投递存储（目前支持 cos、cls）",
          "example": "cos",
          "children": [
            {
              "name": "StorageType",
              "type": "string",
              "required": true,
              "description": "存储类型（目前支持 cos、cls、ckafka）",
              "example": "cos"
            },
            {
              "name": "StorageRegion",
              "type": "string",
              "required": true,
              "description": "存储所在地域",
              "example": "ap-shanghai"
            },
            {
              "name": "StorageName",
              "type": "string",
              "required": true,
              "description": "存储名称(cos：存储名称为用户自定义的存储桶名称，不包含\u0026quot;-APPID\u0026quot;，仅支持小写字母、数字以及中划线\u0026quot;-\u0026quot;的组合，不能超过50字符，且不支持中划线\u0026quot;-\u0026quot;开头或结尾； cls：存储名称为日志主题id，字符长度为1-50个字符； ckafka： ckafka实例ID/topic. 举例：ckafka-xxxxxx/tencent_test_audit_log)",
              "example": "audit"
            },
            {
              "name": "StoragePrefix",
              "type": "string",
              "required": true,
              "description": "存储目录前缀，cos日志文件前缀仅支持字母和数字的组合，3-40个字符",
              "example": "audit"
            },
            {
              "name": "StorageAccountId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户ID",
              "example": "23424"
            },
            {
              "name": "StorageAppId",
              "type": "string",
              "required": false,
              "description": "被指定存储用户appid",
              "example": "3545646"
            },
            {
              "name": "Compress",
              "type": "integer",
              "required": false,
              "description": "是否压缩。1:压缩 2:不压缩",
              "example": "1"
            }
          ]
        },
        {
          "name": "TrackForAllMembers",
          "type": "integer",
          "required": false,
          "description": "是否开启将集团成员操作日志投递到集团管理账号或者可信服务管理账号(0：未开启，1：开启，只能集团管理账号或者可信服务管理账号开启此项功能)",
          "example": "1"
        },
        {
          "name": "Filters",
          "type": "object",
          "required": false,
          "description": "多产品筛选过滤条件",
          "example": "{     \"ResourceFields\": [         {             \"ResourceType\": \"cam\",             \"ActionType\": \"*\",             \"EventNames\": [                 \"AddSubAccount\",                 \"AddSubAccountCheckingMFA\"             ]         },         {             \"ResourceType\": \"cvm\",             \"ActionType\": \"*\",             \"EventNames\": [                 \"*\"             ]         },         {             \"ResourceType\": \"tke\",             \"ActionType\": \"*\",             \"EventNames\": [                 \"*\"             ]         }     ] }",
          "children": [
            {
              "name": "ResourceFields",
              "type": "array",
              "required": false,
              "description": "资源筛选条件",
              "example": "[{\"ResourceType\":\"cam\",\"ActionType\":\"*\",\"EventNames\":[\"AddSubAccount\",\"AddSubAccountCheckingMFA\"]}]",
              "item_type": "object",
              "children": [
                {
                  "name": "ResourceType",
                  "type": "string",
                  "required": true,
                  "description": "跟踪事件所属产品（支持全部产品或单个产品，如：cam，全部：*）",
                  "example": "cvm"
                },
                {
                  "name": "ActionType",
                  "type": "string",
                  "required": true,
                  "description": "跟踪事件类型（读：Read；写：Write；全部：*）",
                  "example": "Read"
                },
                {
                  "name": "EventNames",
                  "type": "array",
                  "required": true,
                  "description": "跟踪事件接口名列表（ResourceType为 * 时，EventNames必须为全部：[\"\"]；指定ResourceType时，支持全部接口：[\"\"]；支持部分接口：[\"cos\", \"cls\"]，接口列表上限10个）",
                  "example": "[\"AddUser\"]",
                  "item_type": "string"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "TrackId"
      ]
    },
    {
      "name": "StartLogging",
      "description": "开启跟踪集",
      "status": "online",
      "parameters": [
        {
          "name": "AuditName",
          "type": "string",
          "required": true,
          "description": "跟踪集名称",
          "example": "audit_log"
        }
      ],
      "required": [
        "AuditName"
      ]
    },
    {
      "name": "StopLogging",
      "description": "关闭跟踪集",
      "status": "online",
      "parameters": [
        {
          "name": "AuditName",
          "type": "string",
          "required": true,
          "description": "跟踪集名称",
          "example": "audit_log"
        }
      ],
      "required": [
        "AuditName"
      ]
    },
    {
      "name": "UpdateAudit",
      "description": "参数要求： 1、如果IsCreateNewBucket的值存在的话，cosRegion和cosBucketName都是必填参数。 2、如果IsEnableCmqNotify的值是1的话，IsCreateNewQueue、CmqRegion和CmqQueueName都是必填参数。 3、如果IsEnableCmqNotify的值是0的话，IsCreateNewQueue、CmqRegion和CmqQueueName都不能传。 4、如果IsEnableKmsEncry的值是1的话，KmsRegion和KeyId属于必填项",
      "status": "online",
      "parameters": [
        {
          "name": "AuditName",
          "type": "string",
          "required": true,
          "description": "跟踪集名称",
          "example": "audit_log"
        },
        {
          "name": "IsEnableCmqNotify",
          "type": "integer",
          "required": false,
          "description": "是否开启cmq消息通知。1：是，0：否。目前仅支持cmq的队列服务。如果开启cmq消息通知服务，操作审计会将您的日志内容实时投递到您指定地域的指定队列中。",
          "example": "1"
        },
        {
          "name": "ReadWriteAttribute",
          "type": "integer",
          "required": false,
          "description": "管理事件的读写属性。1：只读，2：只写，3：全部。",
          "example": "1"
        },
        {
          "name": "KeyId",
          "type": "string",
          "required": false,
          "description": "CMK的全局唯一标识符，如果不是新创建的kms，该值是必填值。可以通过ListKeyAliasByRegion来获取。操作审计不会校验KeyId的合法性，请您谨慎填写，避免给您的数据造成损失。",
          "example": "ak-4m4mkl5433"
        },
        {
          "name": "CosRegion",
          "type": "string",
          "required": false,
          "description": "cos地域。目前支持的地域可以使用ListCosEnableRegion来获取。",
          "example": "ap-guangzhou"
        },
        {
          "name": "CmqQueueName",
          "type": "string",
          "required": false,
          "description": "队列名称。队列名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。如果IsEnableCmqNotify值是1的话，此值属于必填字段。如果不是新创建的队列，操作审计不会去校验该队列是否真的存在，请谨慎填写，避免日志通知不成功，导致您的数据丢失。",
          "example": "audit_queue"
        },
        {
          "name": "IsCreateNewBucket",
          "type": "integer",
          "required": false,
          "description": "是否创建新的cos存储桶。1：是，0：否。",
          "example": "1"
        },
        {
          "name": "KmsRegion",
          "type": "string",
          "required": false,
          "description": "kms地域。目前支持的地域可以使用ListKmsEnableRegion来获取。必须要和cos的地域保持一致。",
          "example": "ap-shanghai"
        },
        {
          "name": "IsEnableKmsEncry",
          "type": "integer",
          "required": false,
          "description": "是否开启kms加密。1：是，0：否。如果开启KMS加密，数据在投递到cos时，会将数据加密。",
          "example": "1"
        },
        {
          "name": "CosBucketName",
          "type": "string",
          "required": false,
          "description": "cos的存储桶名称。仅支持小写英文字母和数字即[a-z，0-9]、中划线“-”及其组合。用户自定义的字符串支持1 - 40个字符。存储桶命名不能以“-”开头或结尾。如果不是新创建的存储桶，操作审计不会去校验该存储桶是否真的存在，请谨慎填写，避免日志投递不成功，导致您的数据丢失。",
          "example": "audit_bucket"
        },
        {
          "name": "CmqRegion",
          "type": "string",
          "required": false,
          "description": "队列所在的地域。可以通过ListCmqEnableRegion获取支持的cmq地域。如果IsEnableCmqNotify值是1的话，此值属于必填字段。",
          "example": "ap-beijing"
        },
        {
          "name": "LogFilePrefix",
          "type": "string",
          "required": false,
          "description": "日志文件前缀。3-40个字符，只能包含 ASCII 编码字母 a-z，A-Z，数字 0-9。",
          "example": "audit"
        },
        {
          "name": "IsCreateNewQueue",
          "type": "integer",
          "required": false,
          "description": "是否创建新的队列。1：是，0：否。如果IsEnableCmqNotify值是1的话，此值属于必填字段。",
          "example": "1"
        }
      ],
      "required": [
        "AuditName"
      ]
    }
  ]
}