1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询镜像拦截规则详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeImageDenyRuleDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| RuleID | 是 | String | 规则RuleID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ID | Integer | 规则ID 示例值:1 |
| RuleName | String | 规则名称 |
| RuleType | String | 规则类型 RULE_RISK:风险, RULE_PRIVILEGE:特权 |
| EffectImageCount | Integer | 生效的镜像数量 |
| IsEffectAllImage | Integer | 是否对全部扫描镜像生效。0:全选镜像,1:自选镜像 示例值:1 |
| EffectTime | String | 规则开始生效时间 |
| UpdateTime | String | 更新时间 |
| OperationUin | String | 操作用户 |
| EffectStatus | String | 生效状态 IN_THE_TEST :观察中,IN_EFFECT:生效中 |
| RuleDescription | String | 规则描述 |
| Status | Integer | 启用状态 0:开启,1:关闭 |
| Vul | Integer | 漏洞,0:未选中,1:选中 示例值:1 |
| CVEIDSet | Array of String | cve编号 |
| ComponentSet | Array of String | 组件编号 |
| VulClassSet | Array of String | 漏洞分类 |
| VulLevelSet | Array of String | 漏洞等级 |
| VulLabelSet | Array of String | 漏洞标签 |
| Virus | Integer | 木马,0:未选中,1:选中 |
| VirusMD5Set | Array of String | 木马md5列表 |
| VirusLevelSet | Array of String | 木马等级 |
| VirusName | Array of String | 病毒名 |
| Risk | Integer | 敏感信息,0:未选中,1:选中 |
| RiskLevelSet | Array of String | 敏感等级 |
| RiskType | Array of String | 敏感信息分类 |
| PrivilegeRun | Integer | 特权启动 0:不允许,1:允许 |
| PrivilegeDetail | Array of String | 特权类型, 注意:此字段可能返回 null,表示取不到有效值。 |
| EffectImageSet | Array of String | 镜像ID列表 |
| EffectDay | Integer | 多少天后生效 |
| RuleID | String | 规则RuelD |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询镜像拦截规则详情
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageDenyRuleDetail
<公共请求参数>
{
"RuleID": "xx"
}
输出示例
{
"Response": {
"VulLabelSet": [
"xx"
],
"EffectImageSet": [
"xx"
],
"OperationUin": "xx",
"EffectImageCount": 1,
"ComponentSet": [
"xx"
],
"EffectStatus": "xx",
"Status": 0,
"EffectTime": "xx",
"Risk": 1,
"RiskLevelSet": [
"xx"
],
"RuleDescription": "xx",
"Virus": 0,
"VulLevelSet": [
"xx"
],
"PrivilegeDetail": [],
"IsEffectAllImage": 0,
"VirusMD5Set": [
"xx"
],
"RiskType": [
"xx"
],
"VirusName": [
"xx"
],
"RuleID": "xx",
"Vul": 0,
"UpdateTime": "xx",
"RequestId": "xx",
"CVEIDSet": [
"xx"
],
"ID": 1,
"PrivilegeRun": 0,
"VulClassSet": [
"xx"
],
"VirusLevelSet": [
"xx"
],
"RuleType": "xx",
"RuleName": "xx",
"EffectDay": 1
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter.MissingParameter | 缺少必须参数。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| UnknownParameter | 未知参数错误。 |