All Products
Search
Document Center

Security Center:PageImageRegistry

Last Updated:Nov 14, 2024

Queries image repositories by page.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegistryTypeInListarrayNo

The types of image repositories.

RegistryTypeInListstringNo

The type of the image repository. Valid values:

  • acr: Container Registry
  • harbor: Harbor
  • quay: Quay
  • CI/CD: Jenkins
acr
RegistryTypeNotInListarrayNo

The types of excluded image repositories.

RegistryTypeNotInListstringNo

The type of the excluded image repository. Valid values:

  • acr: Container Registry
  • harbor: Harbor
  • quay: Quay
  • CI/CD: Jenkins
quay
RegistryNameLikestringNo

The name of the image repository. Fuzzy match is supported.

asa
CurrentPageintegerNo

The number of the page to return.

1
PageSizeintegerNo

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

20
SourceIpstringNo

The source IP address of the request.

140.207.XXX.XXX

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

Listarray<object>

An array that consists of image repositories.

Listobject

The information about the image repository.

Idlong

The ID of the image repository.

1078312
GmtCreatestring

The time when the image repository was created. The time is in the yyyy-MM-dd HH:mm:ss format.

2022-08-30 10:23:30
GmtModifiedstring

The time when the image repository was updated. The time is in the yyyy-MM-dd HH:mm:ss format.

2022-09-30 10:23:30
RegistryNamestring

The alias of the image repository.

test1
RegistryTypestring

The type of the image repository. Valid values:

  • acr: Container Registry.
  • harbor: Harbor.
  • quay: Quay.
  • CI/CD: Jenkins.
harbor
ProtocolTypeinteger

The type of the protocol. Valid values:

  • 1: HTTP.
  • 2: HTTPS.
1
NetTypeinteger

The network type. Valid values:

  • 1: Internet.
  • 2: virtual private cloud (VPC).
1
VpcIdstring

The VPC ID.

vpc-5gu8iu68w9b472jbb****
RegistryHostIpstring

The IP address of the image repository.

39.104.XXX.XXX
DomainNamestring

The domain name of the image repository.

sinochem.com
UserNamestring

The username.

RegistryUser
Passwordstring

The password.

Harbor******
RegionIdstring

The region ID of the image repository.

cn-hangzhou
Tokenstring

The authentication token of the user.

c7b90d29-632f-4e58-88b8-00ad77f6****
WhiteListstring

The IP address whitelist.

192.168.XXX.XXX
BlackListstring

The IP address blacklist.

129.211.XXX.XXX
TransPerHourinteger

The number of scan tasks that are performed per hour.

30
PersistenceDayinteger

The number of days for which assets are retained.

30
ImageCountinteger

The number of images that are stored in the image repository.

1
JenkinsEnvstring

The information about the Jenkins environment.

projectInfo
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 entries returned.

69
Countinteger

The number of entries returned on the current page.

20
RequestIdstring

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

FDA9E37C-6114-5945-8FF1-E3D4D397****

Examples

Sample success responses

JSONformat

{
  "List": [
    {
      "Id": 1078312,
      "GmtCreate": "2022-08-30 10:23:30",
      "GmtModified": "2022-09-30 10:23:30",
      "RegistryName": "test1",
      "RegistryType": "harbor",
      "ProtocolType": 1,
      "NetType": 1,
      "VpcId": "vpc-5gu8iu68w9b472jbb****",
      "RegistryHostIp": "39.104.XXX.XXX",
      "DomainName": "sinochem.com",
      "UserName": "RegistryUser",
      "Password": "Harbor******",
      "RegionId": "cn-hangzhou",
      "Token": "c7b90d29-632f-4e58-88b8-00ad77f6****",
      "WhiteList": "192.168.XXX.XXX",
      "BlackList": "129.211.XXX.XXX",
      "TransPerHour": 30,
      "PersistenceDay": 30,
      "ImageCount": 1,
      "JenkinsEnv": "projectInfo"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69,
    "Count": 20
  },
  "RequestId": "FDA9E37C-6114-5945-8FF1-E3D4D397****"
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
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