1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
高级配置风险规则列表示例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRiskRules。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"] |
Filters.N | 否 | Array of Filters | 过滤内容 示例值:{"Filters":[{"Name":"Status","Values":["0"],"OperatorType":7}]} |
Limit | 否 | Integer | 分页大小 示例值:10 |
Offset | 否 | Integer | 偏移量 示例值:0 |
Order | 否 | String | 排序类型 示例值:desc |
By | 否 | String | 排序字段 示例值:update_time |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 风险规则数量 示例值:1 |
RiskRuleList | Array of RiskRuleItem | 风险规则列表 |
InstanceTypeList | Array of AttributeOptionSet | 实例类型选项 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 高级配置风险规则列表
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRiskRules
<公共请求参数>
{}
输出示例
{
"Response": {
"InstanceTypeList": [
{
"Text": "Elasticsearch Service",
"Value": "es_cluster"
},
{
"Text": "轻量应用服务器",
"Value": "lighthouse_instance"
},
{
"Text": "云数据库 MariaDB",
"Value": "mariadb_instance"
},
{
"Text": "云数据库 MariaDB账号",
"Value": "mariadb_account"
},
{
"Text": "腾讯云可观测平台Grafana服务",
"Value": "monitor_grafana"
},
{
"Text": "NAT网关",
"Value": "nat_gateway"
},
{
"Text": "云数据库 PostgreSQL",
"Value": "postgres_instance"
},
{
"Text": "云数据库 PostgreSQL Serverless版",
"Value": "postgres_serverless"
},
{
"Text": "云数据库Redis",
"Value": "redis_instance"
},
{
"Text": "安全组",
"Value": "security_group"
},
{
"Text": "云数据库 SQL Server",
"Value": "sqlserver_instance"
},
{
"Text": "访问管理用户密钥",
"Value": "cam_user_ak"
},
{
"Text": "访问管理用户",
"Value": "cam_user"
},
{
"Text": "容器服务标准集群",
"Value": "tke_cluster"
},
{
"Text": "容器服务边缘集群",
"Value": "edge_cluster"
},
{
"Text": "容器服务Serverless集群",
"Value": "eks_cluster"
},
{
"Text": "微服务引擎Apollo服务",
"Value": "tse_apollo"
},
{
"Text": "微服务引擎Eureka服务",
"Value": "tse_eureka"
},
{
"Text": "微服务引擎Nacos服务",
"Value": "tse_nacos"
},
{
"Text": "微服务引擎Polaris服务",
"Value": "tse_polaris"
},
{
"Text": "微服务引擎Zookeeper服务",
"Value": "tse_zookeeper"
},
{
"Text": "微服务引擎云原生API网关",
"Value": "kong_instance"
},
{
"Text": "云服务器",
"Value": "cvm_instance"
},
{
"Text": "消息队列 TDMQ RocketMQ版",
"Value": "tdmq_rocketmq"
},
{
"Text": "消息队列 TDMQ RabbitMQ版",
"Value": "tdmq_rabbitmq"
},
{
"Text": "消息队列 TDMQ Pulsar版",
"Value": "tdmq_pulsar"
},
{
"Text": "Web 应用防火墙",
"Value": "waf_instance"
},
{
"Text": "VPN网关",
"Value": "vpn_gateway"
},
{
"Text": "文件存储",
"Value": "cfs_instance"
},
{
"Text": "云数据库 MySQL",
"Value": "cdb_instance"
},
{
"Text": "云数据库 MySQL账号",
"Value": "cdb_account"
},
{
"Text": "域名记录",
"Value": "domain_record"
},
{
"Text": "消息队列 CKafka 版",
"Value": "ckafka_instance"
},
{
"Text": "负载均衡",
"Value": "clb_instance"
},
{
"Text": "对象存储",
"Value": "cos_bucket"
},
{
"Text": "TDSQL-C MySQL 版",
"Value": "cynosdb_cluster"
},
{
"Text": "TDSQL-C MySQL 版账号",
"Value": "cynosdb_account"
},
{
"Text": "TDSQL MySQL 版",
"Value": "dcdb_instance"
},
{
"Text": "弹性 MapReduce",
"Value": "emr_cluster"
},
{
"Text": "云函数函数服务",
"Value": "scf_instance"
},
{
"Text": "云数据库 SQL Server账号",
"Value": "sqlserver_account"
},
{
"Text": "云数据库 MongoDB",
"Value": "mongodb_instance"
},
{
"Text": "云数据库 KeeWiDB",
"Value": "keewidb_instance"
},
{
"Text": "容器服务标准集群策略",
"Value": "tke_policy"
},
{
"Text": "向量数据库",
"Value": "vdb_instance"
},
{
"Text": "Elasticsearch Service采集器",
"Value": "es_beats"
},
{
"Text": "主机漏洞",
"Value": "cwp_asset_vuln"
},
{
"Text": "主机基线风险",
"Value": "cwp_asset_baseline_risk"
},
{
"Text": "主机列表",
"Value": "cwp_asset_machine"
},
{
"Text": "主机安全事件",
"Value": "cwp_asset_event"
}
],
"RequestId": "651a037f-9bab-42ba-980c-6e26c7935191",
"RiskRuleList": [
{
"CheckType": "network_security",
"InstanceName": "Elasticsearch Service",
"InstanceType": "es_cluster",
"Provider": "腾讯云",
"RiskInfluence": "云上多种产品都有管理后台功能且具有对公网开放能力,管理后台对外开放后后容易存在口令被爆破/被入侵风险,可导致重要数据泄露,服务器遭受入侵等严重后果。",
"ItemId": "11.1-10.1",
"RiskTitle": "Elasticsearch Service对外网开放管理后台",
"Severity": "high"
}
],
"TotalCount": 179
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。