Queries information about images that are affected by sensitive files.
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:DescribeImageListBySensitiveFile | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
SensitiveFileKey | string | No | The type of the alert for the sensitive file. Valid values:
| sshpasswd |
ScanRange | array | No | An array consisting of the types of the assets that you want to scan. Valid values:
| |
ScanRange | string | No | An array consisting of the types of the assets that you want to scan. Valid values:
| image |
Lang | string | No | The language of the content within the request and response. Default value: zh. Valid values:
| zh |
CurrentPage | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Default value: 20. | 20 |
RiskLevel | string | No | The risk level of the file. Separate multiple levels with commas (,). Valid values:
| high |
RepoInstanceId | string | No | The ID of the specified container image. Note
You can call the ListRepository operation to obtain the IDs of container images from the value of the InstanceId response parameter.
| i-qewqrqcsadf**** |
RepoName | string | No | The name of the image repository. Note
Fuzzy match is supported.
| harbor-image-v001 |
RepoNamespace | string | No | The namespace to which the image repository belongs. Note
Fuzzy match is supported.
| libssh2 |
ImageDigest | string | No | The image digest. Note
Fuzzy match is supported.
| v005 |
Status | string | No | The sensitive file status. Valid values:
| 0 |
Response parameters
Examples
Sample success responses
JSON
format
{
"ImageInfos": [
{
"Uuid": "f58681174f944623345379e23b7b****",
"RegionId": "cn-hangzhou",
"InstanceId": "cri-a595qp31knh9****",
"RepoNamespace": "libssh2",
"RepoName": "opa-test",
"Digest": "v005",
"Tag": "nuxeo6",
"FirstScanTime": 1649814050000,
"LastScanTime": 1649814050000,
"RiskLevel": "low",
"Status": "0"
}
],
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 83,
"Count": 4,
"LastRowKey": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE="
},
"Success": true,
"Code": "200",
"Message": "successful",
"RequestId": "E0C5C07F-1576-509A-AE44-1C36B8445B37",
"HttpStatusCode": 200
}
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 |
---|---|---|
2024-10-31 | The Error code has changed | View Change Details |
2023-10-17 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |