All Products
Search
Document Center

Security Center:DescribeImageRepoDetailList

Last Updated:Nov 13, 2024

Queries the information about image repositories.

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

Request parameters

ParameterTypeRequiredDescriptionExample
CriteriastringNo

The search conditions for assets. The value of this parameter is in the JSON format and contains the following fields:

  • name: the search condition.

  • name: the value of the search condition.

  • logicalExp: the logical relation for multiple search conditions. Valid values:

    • OR: The search conditions use a logical OR.
    • AND: The search conditions use a logical AND.
Note You can call the DescribeImageRepoCriteria operation to query the supported search conditions.
[{"name":"vulStatus","value":"YES","logicalExp":"AND"}]
LogicalExpstringNo

The logical relationship that you want to use to evaluate multiple search conditions. Valid values:

  • OR: Search conditions are evaluated by using a logical OR.
  • AND: Search conditions are evaluated by using a logical AND.
OR
PageSizeintegerNo

The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
CurrentPageintegerNo

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

1

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

0B48AB3C-84FC-424D-A01D-B9270EF46038
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of image repositories.

19
Countinteger

The number of entries returned on the current page.

2
ImageRepoResponsesarray<object>

An array that consists of the information about image repositories.

responseobject

The information about the image repository.

Endpointsstring

The address of the image repository.

[ { "domains": [ "****.cn-shenzhen.cr.aliyuncs.com" ], "type": "internet" }, { "domains": [ "****.cn-shenzhen.cr.aliyuncs.com" ], "type": "intranet" }, { "domains": [ "****.cn-shenzhen.cr.aliyuncs.com" ], "type": "vpc" } ]
RiskStatusstring

Indicates whether the image repository is at risk. Valid values:

  • YES
  • NO
NO
VulStatusstring

Indicates whether vulnerabilities are detected on the image repository. Valid values:

  • YES
  • NO
NO
AlarmStatusstring

Indicates whether alerts are generated for the image repository. Valid values:

  • YES
  • NO
NO
RegistryTypestring

The type of the image repository. Valid values:

  • acr
  • harbor
  • quay
  • CI/CD
acr
InstanceIdstring

The ID of the image.

i-uf6fsg6xlmorug5****
RegionIdstring

The region ID of the image.

cn-shanghai
RepoIdstring

The ID of the image repository.

crr-2chlzf47w2rk****
HcCountinteger

The number of baseline risk items on the image repository.

0
VulCountinteger

The number of vulnerabilities detected on the image repository.

0
HcStatusstring

Indicates whether baseline risk items are detected on the image repository. Valid values:

  • NO
  • YES
NO
AlarmCountinteger

The number of alerts that are generated for the image repository.

0
RepoNamestring

The name of the image repository.

zeus
RepoNamespacestring

The namespace to which the image repository belongs.

test-dev
ImageCountinteger

The number of images.

3

Examples

Sample success responses

JSONformat

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF46038",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 19,
    "Count": 2
  },
  "ImageRepoResponses": [
    {
      "Endpoints": "[\n      {\n            \"domains\": [\n                  \"****.cn-shenzhen.cr.aliyuncs.com\"\n            ],\n            \"type\": \"internet\"\n      },\n      {\n            \"domains\": [\n                  \"****.cn-shenzhen.cr.aliyuncs.com\"\n            ],\n            \"type\": \"intranet\"\n      },\n      {\n            \"domains\": [\n                  \"****.cn-shenzhen.cr.aliyuncs.com\"\n            ],\n            \"type\": \"vpc\"\n      }\n]",
      "RiskStatus": "NO",
      "VulStatus": "NO",
      "AlarmStatus": "NO",
      "RegistryType": "acr",
      "InstanceId": "i-uf6fsg6xlmorug5****",
      "RegionId": "cn-shanghai",
      "RepoId": "crr-2chlzf47w2rk****",
      "HcCount": 0,
      "VulCount": 0,
      "HcStatus": "NO",
      "AlarmCount": 0,
      "RepoName": "zeus",
      "RepoNamespace": "test-dev",
      "ImageCount": 3
    }
  ]
}

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
No change history