All Products
Search
Document Center

Security Center:DescribeImageListBySensitiveFile

Last Updated:Nov 13, 2024

Queries information about images that are affected by sensitive files.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeImageListBySensitiveFileget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SensitiveFileKeystringNo

The type of the alert for the sensitive file. Valid values:

  • npm_token: npm access token.
  • ftp_cfg: FTP configuration.
  • google_oauth_key: Google OAuth key.
  • planetscale_passwd: PlanetScale password.
  • github_ssh_key: Github SSH key.
  • msbuild_publish_profile: MSBuild publish profile.
  • fastly_cdn_token: Fastly CDN token.
  • ssh_private_key: SSH private key.
  • aws_cli: Amazon Web Services (AWS) CLI credential.
  • cpanel_proftpd: cPanel ProFTPD credential.
  • postgresql_passwd: PostgreSQL password file.
  • discord_client_cred: Discord client credential.
  • rails_database: Rails database configuration.
  • aws_access_key: AWS access key.
  • esmtp_cfg: configuration of mail server over Extended Simple Mail Transfer Protocol (ESMTP).
  • docker_registry_cfg: configuration of a Docker image repository.
  • pem: Privacy-Enhanced Mail (PEM).
  • common_cred: common credential.
  • sftp_cfg: configuration of connection over Secure File Transfer Protocol (SFTP).
  • grafana_token: Grafana token.
  • slack_token: Slack token.
  • ec_private_key: Elliptic Curve (EC) private key.
  • pypi_token: Python Package Index (PyPI) token.
  • finicity_token: Finicity token.
  • k8s_client_key: private key for the Kubernetes client.
  • git_cfg: Git configuration.
  • django_key: Django key.
  • jenkins_ssh: SSH configuration file for Jenkins.
  • openssh_private_key: OpenSSH private key.
  • square_oauth: Square OAuth credential.
  • typeform_token: Typeform token.
  • common_database_cfg: configuration of general database connection.
  • wordpress_database_cfg: WordPress database configuration.
  • googlecloud_api_key: API key for Google Cloud.
  • vscode_sftp: VSCode SFTP configuration.
  • apache_htpasswd: Apache htpasswd.
  • planetscale_token: PlanetScale token.
  • contentful_preview_token: preview token for Contentful.
  • php_database_cfg: database password for a PHP application.
  • atom_remote_sync: Atom remote synchronization configuration.
  • aws_session_token: AWS session token.
  • atom_sftp_cfg: Atom SFTP configuration.
  • asana_client_private_key: private key for the Asana client.
  • tencentcloud_ak: secret ID of a third-party cloud.
  • rsa_private_key: Rivest-Shamir-Adleman (RSA) private key.
  • github_personal_token: personal access token for GitHub.
  • pgp: Pretty Good Privacy (PGP) encrypted file.
  • stripe_skpk: Stripe secret key.
  • square_token: Square access token.
  • rails_carrierwave: Rails Carrierwave credential.
  • dbeaver_database_cfg: DBeaver database configuration.
  • robomongo_cred: RoboMongo credential.
  • github_oauth_token: OAuth access token for GitHub.
  • pulumi_token: Pulumi token.
  • ventrilo_voip: configuration of a Ventrilo VoIP server.
  • macos_keychain: macOS keychain.
  • amazon_mws_token: Amazon MWS token.
  • dynatrace_token: Dynatrace token.
  • java_keystore: Java KeyStore (JKS).
  • microsoft_sdf: Microsoft SQL Server Compact Edition (CE) database.
  • kubernetes_dashboard_cred: user credential for Kubernetes Dashboard.
  • atlassian_token: Atlassian token.
  • rdp: remote desktop protocol (RDP).
  • mailgun_key: Mailgun webhook signing key.
  • mailchimp_api_key: API key for Mailchimp.
  • netrc_cfg: .netrc configuration file.
  • openvpn_cfg: configuration of the OpenVPN client.
  • github_refresh_token: GitHub refresh token.
  • salesforce: Salesforce credential.
  • salesforce: Sendinblue token.
  • pkcs_private_key: PKCS#12 private key.
  • rubyonrails_passwd: Ruby on Rails password file.
  • filezilla_ftp: FileZilla FTP configuration.
  • databricks_token: Databricks token.
  • gitLab_personal_toke: personal access token for GitLab.
  • rails_master_key: Rails master key.
  • sqlite: SQLite3 or SQLite database.
  • firefox_logins: Firefox logon configuration.
  • mailgun_private_token: Mailgun private token.
  • joomla_cfg: Joomla configuration.
  • hashicorp_terraform_token: HashiCorp Terraform token.
  • jetbrains_ides: JetBrains IDEs configuration.
  • heroku_api_key: API key for Heroku.
  • messagebird_token: MessageBird token.
  • github_app_token: Github app token.
  • hashicorp_vault_token: HashiCorp Vault token.
  • pgp_private_key: PGP private key.
  • sshpasswd: SSH password.
  • huaweicloud_ak: secret access key of a third-party cloud.
  • aws_s3cmd: AWS S3cmd configuration.
  • php_config: PHP configuration.
  • common_private_key: common private key.
  • microsoft_mdf: Microsoft SQL Server database.
  • mediawiki_cfg: MediaWiki configuration.
  • jenkins_cred: Jenkins credential.
  • rubygems_cred: RubyGems credential.
  • clojars_token: Clojars token.
  • phoenix_web_passwd: Phoenix web credential.
  • puttygen_private_key: PuTTYgen private key.
  • google_oauth_token: Google OAuth access token.
  • rubyonrails_cfg: Ruby On Rails database configuration.
  • lob_api_key: Lob API key for Lob.
  • pkcs_cred: PKCS#12 certificate.
  • otr_private_key: Off-the-Record Messaging (OTR) private key.
  • contentful_delivery_token: Contentful delivery token.
  • digital_ocean_tugboat: DigitalOcean Tugboat configuration.
  • dsa_private_key: Digital Signature Algorithm (DSA) private key.
  • rails_app_token: app token for Rails.
  • git_cred: user credential for Git.
  • newrelic_api_key: User API key for New Relic.
  • github_hub: hub configuration for storing GitHub tokens.
  • rubygem: RubyGem token.
sshpasswd
ScanRangearrayNo

An array consisting of the types of the assets that you want to scan. Valid values:

  • image
  • container
ScanRangestringNo

An array consisting of the types of the assets that you want to scan. Valid values:

  • image
  • container
image
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
CurrentPageintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 20.

20
RiskLevelstringNo

The risk level of the file. Separate multiple levels with commas (,). Valid values:

  • high
  • medium
  • low
high
RepoInstanceIdstringNo

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****
RepoNamestringNo

The name of the image repository.

Note Fuzzy match is supported.
harbor-image-v001
RepoNamespacestringNo

The namespace to which the image repository belongs.

Note Fuzzy match is supported.
libssh2
ImageDigeststringNo

The image digest.

Note Fuzzy match is supported.
v005
StatusstringNo

The sensitive file status. Valid values:

  • 0: unhandled
  • 1: ignored
  • 2: false positive
0

Response parameters

ParameterTypeDescriptionExample
object

The information about the affected images.

ImageInfosarray<object>

The information about the images.

Listobject

The information about the image.

Uuidstring

The image UUID.

f58681174f944623345379e23b7b****
RegionIdstring

The ID of the region in which the image instance resides.

cn-hangzhou
InstanceIdstring

The image instance ID.

cri-a595qp31knh9****
RepoNamespacestring

The namespace to which the image repository belongs.

libssh2
RepoNamestring

The image repository name.

opa-test
Digeststring

The image digest.

v005
Tagstring

The tag that is added to the image.

nuxeo6
FirstScanTimelong

The timestamp generated when the first scan was performed. Unit: milliseconds.

1649814050000
LastScanTimelong

The timestamp when the last scan was performed. Unit: milliseconds.

1649814050000
RiskLevelstring

The risk level. Valid values:

  • high
  • medium
  • low
low
Statusstring

The sensitive file status. Valid values:

  • 0: unhandled
  • 1: ignored
  • 2: false positive
0
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page. Default value: 20.

20
TotalCountinteger

The total number of entries returned.

83
Countinteger

The number of entries returned on the current page.

4
LastRowKeystring

The key of the last data entry.

CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codestring

The status code returned. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.

200
Messagestring

The error message returned.

successful
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

E0C5C07F-1576-509A-AE44-1C36B8445B37
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-31The Error code has changedView Change Details
2023-10-17The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details