Viewing the List of Shared Images

Function

View the list of shared images.

URI

GET /v2/manage/shared-repositories?filter=center::{center}|name::{name}|limit::{limit}|offset::{offset}

For details about parameters, see Table 1.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

center

Yes

String

  • self: images shared by you.

  • thirdparty: images shared with you by others.

name

No

String

Image repository name.

limit

No

String

Number of returned records. Ensure that the offset and limit parameters are used together.

offset

No

String

Start index. Ensure that the offset and limit parameters are used together.

Request

  • Request parameters

    N/A

  • Example request

    GET https://{Endpoint}/v2/manage/shared-repositories?filter=center::self|name::busybox
    

Response

  • Response parameters

    Table 2 Response header parameter description

    Parameter

    Type

    Description

    Content-Range

    String

    Offset (Start index)-Count (Number of records on the current page)/Total (Total number of records)

    Note

    If the offset and limit parameters are transferred in the request, Content-Range will be added to the response header.

    Table 3 Response body parameter description

    Parameter

    Type

    Description

    [Array element]

    Array of objects

    Viewing the list of shared images.

    Table 4 [Array element] parameters description

    Parameter

    Type

    Description

    name

    String

    Image repository name.

    category

    String

    Image repository type. The value can be app_server, linux, framework_app, database, lang, other, windows, or arm.

    description

    String

    Image repository description.

    size

    Integer

    Total size of the images in an image repository.

    is_public

    Boolean

    Whether the image is a public image. The value can be true or false.

    num_images

    Integer

    Number of image tags in an image repository.

    num_download

    Integer

    Download times.

    created_at

    String

    Time when an image repository is created. It is the UTC standard time.

    updated_at

    String

    Time when an image repository is updated. It is the UTC standard time.

    logo

    String

    (Reserved field) Image repository logo address.

    url

    String

    (Reserved field) URL of the image repository logo.

    path

    String

    External Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.

    internal_path

    String

    Internal Docker pull address. The format is {Repository address}/{Namespace name}/{Repository name}.

    domain_name

    String

    Account name.

    namespace

    String

    Organization name.

    tags

    Array of strings

    Image tag list.

    status

    Boolean

    • Query the images shared by a third party: Check whether the sharing is expired.

    • Query the images shared by me: The default value is false, indicating that no images are shared.

    total_range

    Integer

    Total number of records.

  • Example response

    [
        {
            "name": "busybox",
            "category": "other",
            "description": "",
            "size": 115645792,
            "is_public": false,
            "num_images": 1,
            "num_download": 0,
            "created_at": "2021-06-02T09:23:01.751202Z",
            "updated_at": "2021-06-10T07:24:35.204517Z",
            "logo": "",
            "url": "",
            "path": "{Repository address}/group/busybox",
            "internal_path": "{Repository address}/group/busybox",
            "domain_name": "domain",
            "namespace": "namespace",
            "tags": [
                "v1",
                "v2"
            ],
            "status": true,
            "total_range": 1
        }
    ]
    

Status Code

Status Code

Description

200

Request successful.

400

Request error. Error information is returned.

401

Authentication failed.

500

Internal error. Error information is returned.