All Products
Search
Document Center

Security Center:DescribeImageRepoCriteria

Last Updated:Nov 25, 2024

Obtains the filter conditions that are supported by the image repository.

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:DescribeImageRepoCriteriaget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ValuestringNo

The value of the filter condition.

Note You can perform fuzzy search based on the image ID, image tag, image instance ID, image repository name, image repository namespace, image repository ID, image repository region, image digest, and image repository type.
2.0.2

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

F35F45B0-5D6B-4238-BE02-A62D0760E840
CriteriaListarray<object>

An array consisting of the filter conditions that are supported by the image repository.

Criteriaobject

The information about the filter condition that is supported by the image repository.

Typestring

The type of the search condition. Valid values:

  • input: The search condition needs to be specified.
  • select: The search condition is an option that can be selected from the drop-down list.
select
Namestring

The name of the search condition. Valid values:

  • instanceId: the ID of the image instance.
  • repoName: the name of the image repository.
  • repoId: the ID of the image repository.
  • repoNamespace: the namespace of the image repository.
  • regionId: the region in which the image resides.
  • vulStatus: indicates whether vulnerabilities exist.
  • alarmStatus: indicates whether security alerts exist.
  • hcStatus: indicates whether baseline risks exist.
  • riskStatus: indicates whether risks exist.
  • registryType: the type of the image repository.
  • ImageId: the image ID.
  • tag: the image tag.
vulStatus
Valuesstring

The values of the search condition. This parameter is returned only if the value of Type is set to select.

Note If the value of Type is set to input, the return value of this parameter is empty.
NO,YES

Examples

Sample success responses

JSONformat

{
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D0760E840",
  "CriteriaList": [
    {
      "Type": "select",
      "Name": "vulStatus",
      "Values": "NO,YES"
    }
  ]
}

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.