Yandex Cloud Registry API, gRPC: ArtifactService.List
Returns a list of artifacts.
gRPC request
rpc List (ListArtifactsWithFiltersRequest) returns (ListArtifactsWithFiltersResponse)
ListArtifactsWithFiltersRequest
{
"folder_id": "string",
"registry_id": "string",
"registry_kind": [
"Kind"
],
"registry_type": [
"Type"
],
"page_size": "int64",
"page_token": "string",
"name_filter": "string",
"path_filter": "string",
"status": [
"Status"
],
"kind": [
"Kind"
],
"labels": [
"string"
],
"created_after": "google.protobuf.Timestamp",
"created_before": "google.protobuf.Timestamp",
"order_by": "string"
}
|
Field |
Description |
|
folder_id |
string ID of the folder to list artifacts in. The maximum string length in characters is 50. |
|
registry_id |
string ID of the registry to list artifacts in. The maximum string length in characters is 50. |
|
registry_kind[] |
enum Kind Match by registry kind (for example DOCKER, MAVEN, NPM).
|
|
registry_type[] |
enum Type Match by registry type (for example LOCAL, REMOTE). Supported kinds: LOCAL, REMOTE
|
|
page_size |
int64 Page size. Acceptable values are 0 to 1000, inclusive. |
|
page_token |
string Page token from the previous response. Empty for the first page. |
|
name_filter |
string Filter by artifact name.
The maximum string length in characters is 1000. |
|
path_filter |
string Filter by artifact path.
The maximum string length in characters is 1000. |
|
status[] |
enum Status Match by artifact status. Empty list means any status.
|
|
kind[] |
enum Kind Match by artifact kind. Empty list means any kind (both FOLDER and ARTIFACT).
|
|
labels[] |
string Match by labels. All listed labels must match (AND). |
|
created_after |
Return items created at this time or later. |
|
created_before |
Return items created before this time. |
|
order_by |
string Sort order. Comma-separated "field [asc|desc]", e.g. "name desc". The maximum string length in characters is 256. |
ListArtifactsWithFiltersResponse
{
"artifacts": [
{
"id": "string",
"path": "string",
"name": "string",
"kind": "Kind",
"status": "Status",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"modified_by": "string",
"properties": "map<string, string>",
"content": {
// Includes only one of the fields `docker`
"docker": {
// Includes only one of the fields `image_manifest`, `manifest_list`
"image_manifest": {
"config": {
"digest": "string",
"size": "int64"
},
"layers": [
{
"digest": "string",
"size": "int64"
}
]
},
"manifest_list": {
"manifests": [
{
"manifest_descriptor": {
"digest": "string",
"size": "int64"
},
"platform": {
"architecture": "string",
"os": "string",
"os_version": "string",
"variant": "string"
}
}
]
},
// end of the list of possible fields
"manifest_digest": "string"
}
// end of the list of possible fields
},
"registry_id": "string"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
artifacts[] |
List of artifacts that match the request. |
|
next_page_token |
string Token to get the next page of results. |
Artifact
A Artifact resource.
|
Field |
Description |
|
id |
string Output only. ID of the artifact. |
|
path |
string Path where the artifact is located. |
|
name |
string Name of the artifact. |
|
kind |
enum Kind Kind of the artifact.
|
|
status |
enum Status Output only. Status of the artifact.
|
|
created_at |
Output only. Creation timestamp in RFC3339 text format. |
|
created_by |
string Output only. ID of the user or service account who created the artifact. |
|
modified_at |
Output only. Modification timestamp in RFC3339 text format. |
|
modified_by |
string Output only. ID of the user or service account who last modified the artifact. |
|
properties |
object (map<string, string>) Key-value properties associated with the artifact. |
|
content |
Content of the artifact. |
|
registry_id |
string Output only. ID of the registry that contains this artifact. |
Content
Content of the artifact, specific to its type.
|
Field |
Description |
|
docker |
Docker-specific content. Includes only one of the fields |
DockerContent
Docker-specific content of the artifact.
|
Field |
Description |
|
image_manifest |
Single-platform image manifest. Includes only one of the fields |
|
manifest_list |
Multi-platform manifest list. Includes only one of the fields |
|
manifest_digest |
string Digest of the manifest. |
ImageManifest
Image manifest describing a single-platform Docker image.
|
Field |
Description |
|
config |
Descriptor of the image configuration. |
|
layers[] |
Descriptors of the image layers. |
Descriptor
Descriptor of a content blob (config, layer, or manifest).
|
Field |
Description |
|
digest |
string Digest of the content. |
|
size |
int64 Size of the content in bytes. |
ManifestList
Manifest list describing a multi-platform Docker image.
|
Field |
Description |
|
manifests[] |
List of platform-specific manifests. |
PlatformManifest
Platform-specific manifest entry within a manifest list.
|
Field |
Description |
|
manifest_descriptor |
Descriptor of the platform-specific manifest. |
|
platform |
Platform this manifest targets. |
Platform
Platform describes the target OS and architecture of an image.
|
Field |
Description |
|
architecture |
string CPU architecture. |
|
os |
string Operating system. |
|
os_version |
string OS version. |
|
variant |
string CPU variant. |