Creates a rule to block at-risk images.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
yundun-sas:CreateOpaStrategyNew | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
StrategyId | long | No | The rule ID. Note
You can call the ListOpaClusterStrategyNew operation to query the rule ID.
Note
This parameter is invalid when you create a rule.
| 16 |
StrategyTemplateId | long | No | The ID of the rule template. Note
You can call the GetOpaStrategyTemplateSummary operation to query the ID of the rule template.
| 109 |
ClusterId | string | No | The cluster ID. Note
This parameter is deprecated.
| cfa7e2fb8c221483ba59e098c34c6**** |
StrategyName | string | No | The rule name. | default |
Description | string | No | The rule description. | default policy |
ClusterName | string | No | The cluster name. Note
This parameter is deprecated.
| * |
UnScanedImage | boolean | No | Specifies whether the rule supports unscanned images. Valid values:
| true |
MaliciousImage | boolean | No | Specifies whether the rule supports malicious Internet images. Valid values:
| true |
ImageName | array | No | The image names. | |
ImageName | string | No | The image name. Note
You can call the GetOpaClusterImageList operation to query the image name.
| testImage |
Label | array | No | The container tags. | |
Label | string | No | The container tag. Note
You can call the GetOpaClusterLabelList operation to query the container tag.
| app.kubernetes.io/component:collector |
RuleAction | integer | No | The action that is performed when the rule is hit. Valid values:
| 1 |
WhiteList | array | No | The whitelist. | |
WhiteList | string | No | The entry in the whitelist. | repo-06 |
AlarmDetail | object | No | The risks that you want to detect by using the rule. | |
Baseline | object | No | The baseline risks. | |
RiskLevel | array | No | The risk levels. | |
RiskLevel | string | No | The risk level. Valid values:
| high |
Item | array<object> | No | The baseline check items. | |
Item | object | No | ||
Id | string | No | The ID of the baseline check item. Note
You can call the GetOpaClusterBaseLineList operation to query the ID.
| hc.image.checklist.identify.hc_exploit_couchdb_linux.item |
Name | string | No | The name of the baseline check item. Note
You can call the GetOpaClusterBaseLineList operation to query the name.
| Unauthorized access to CouchDB configuration risk |
Vul | object | No | The vulnerability risks. | |
RiskLevel | array | No | The risk levels. | |
RiskLevel | string | No | The risk level. Valid values:
| high |
Item | array<object> | No | The vulnerabilities. | |
Item | object | No | ||
Id | string | No | The ID of the vulnerability. Note
You can call the DescribeVulListPage operation to query the ID.
| CVE-2023-36034 |
Name | string | No | The name of the vulnerability. Note
You can call the DescribeVulListPage operation to query the name.
| Microsoft Edge vul |
RiskClass | array<object> | No | Risk type of vulnerability. | |
Item | object | No | ||
Id | string | No | The ID of the vulnerability types. Valid values:
| cve |
Name | string | No | The name of the vulnerability. Valid values:
| system vulnerability |
MaliciousFile | object | No | The malicious sample risks. | |
RiskLevel | array | No | The risk levels. | |
RiskLevel | string | No | The risk level. Valid values:
| high |
Item | array<object> | No | The malicious samples. | |
Item | object | No | ||
Id | string | No | The ID of the malicious sample. Note
You can call the DescribeMatchedMaliciousNames operation to query the ID.
| 3685699 |
Name | string | No | The name of the malicious sample. Note
You can call the DescribeMatchedMaliciousNames operation to query the name.
| abnormal binary file |
SensitiveFile | object | No | The configuration of sensitive file. | |
RiskLevel | array | No | The risk levels. | |
RiskLevel | string | No | The risk level. Valid values:
| low |
Item | array<object> | No | The configuration of sensitive file. | |
Item | object | No | ||
Id | string | No | The ID of the sensitive files. Note
You can call the GetSensitiveDefineRuleConfig operation to query the ID of the malicious sample.
| key |
Name | string | No | The name of the sensitive files. Note
You can call the GetSensitiveDefineRuleConfig operation to query the ID of the malicious sample.
| name |
BuildRisk | object | No | The configuration of image build risk. | |
RiskLevel | array | No | The risk levels. | |
RiskLevel | string | No | The risk level. Valid values:
| low |
Item | array<object> | No | The configuration of image build risk. | |
Item | object | No | ||
Id | string | No | The ID of the image build risk. Note
You can call the ListImageBuildRiskItem operation to query the ID of the malicious sample.
| key |
Name | string | No | The name of the image build risk. Note
You can call the ListImageBuildRiskItem operation to query the ID of the malicious sample.
| name |
Scopes | array<object> | No | The application scope of the rule. | |
Scope | object | No | ||
ClusterId | string | No | The ID of the cluster that is specified in the rule. Note
You can call the DescribeGroupedContainerInstances operation to query the cluster ID.
| cc50d***015d2 |
AllNamespace | integer | No | Specifies whether to include all namespaces. Valid values:
| 1 |
NamespaceList | array | No | The namespaces. Note
This parameter is valid only when the AllNamespace parameter is set to 0.
| |
NamespaceList | string | No | The namespace. Note
You can call the GetOpaClusterNamespaceList operation to query the namespace.
| namespace1 |
AckPolicyInstanceId | string | No | The ID of the cluster node to which the rule is applied. Note
This parameter is not required when you create the instance.
| ack-p-1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Success": true,
"Code": "200",
"Message": "success",
"RequestId": "CD380235-A0B8-540D-A0D5-D62884469E3C",
"HttpStatusCode": 200,
"Data": [
"['cb8cd***b07ee5']"
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
500 | ServerError | ServerError | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-12-22 | The Error code has changed | View Change Details |