Container Registry API, gRPC: RegistryService

A set of methods for managing Registry resources.

Call	Description
Get	Returns the specified Registry resource.
List	Retrieves the list of Registry resources in the specified folder.
Create	Creates a registry in the specified folder.
Update	Updates the specified registry.
Delete	Deletes the specified registry.
ListAccessBindings	Lists access bindings for the specified registry.
SetAccessBindings	Sets access bindings for the specified registry.
UpdateAccessBindings	Updates access bindings for the specified registry.
ListIpPermission	List ip permissions for the specified registry.
SetIpPermission	Set ip permissions for the specified registry.
UpdateIpPermission	Update ip permissions for the specified registry.

Calls RegistryService

Get

Returns the specified Registry resource.
To get the list of available Registry resources, make a List request.

rpc Get (GetRegistryRequest) returns (Registry)

GetRegistryRequest

Field	Description
registry_id	string Required. ID of the Registry resource to return. To get the registry ID use a RegistryService.List request. The maximum string length in characters is 50.

Registry

Field	Description
id	string Output only. ID of the registry.
folder_id	string ID of the folder that the registry belongs to.
name	string Name of the registry.
status	enum Status Output only. Status of the registry. CREATING: Registry is being created. ACTIVE: Registry is ready to use. DELETING: Registry is being deleted.
created_at	google.protobuf.Timestamp Output only. Creation timestamp in RFC3339 text format.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

List

Retrieves the list of Registry resources in the specified folder.

rpc List (ListRegistriesRequest) returns (ListRegistriesResponse)

ListRegistriesRequest

Field	Description
folder_id	string Required. ID of the folder to list registries in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListRegistriesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListRegistriesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently you can use filtering only on Registry.name field. An = operator. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. The maximum string length in characters is 1000.

ListRegistriesResponse

Field	Description
registries[]	Registry List of Registry resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListRegistriesRequest.page_size, use the next_page_token as the value for the ListRegistriesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Registry

Field	Description
id	string Output only. ID of the registry.
folder_id	string ID of the folder that the registry belongs to.
name	string Name of the registry.
status	enum Status Output only. Status of the registry. CREATING: Registry is being created. ACTIVE: Registry is ready to use. DELETING: Registry is being deleted.
created_at	google.protobuf.Timestamp Output only. Creation timestamp in RFC3339 text format.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

Create

Creates a registry in the specified folder.

rpc Create (CreateRegistryRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateRegistryMetadata

    Operation.response:Registry

CreateRegistryRequest

Field	Description
folder_id	string Required. ID of the folder to create a registry in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name	string Name of the registry. There may be only one registry per folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
labels	map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<CreateRegistryMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Registry> if operation finished successfully.

CreateRegistryMetadata

Field	Description
registry_id	string ID of the registry that is being created.

Registry

Field	Description
id	string Output only. ID of the registry.
folder_id	string ID of the folder that the registry belongs to.
name	string Name of the registry.
status	enum Status Output only. Status of the registry. CREATING: Registry is being created. ACTIVE: Registry is ready to use. DELETING: Registry is being deleted.
created_at	google.protobuf.Timestamp Output only. Creation timestamp in RFC3339 text format.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

Update

Updates the specified registry.

rpc Update (UpdateRegistryRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateRegistryMetadata

    Operation.response:Registry

UpdateRegistryRequest

Field	Description
registry_id	string Required. ID of the Registry resource to update. To get the registry ID use a RegistryService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the Registry resource are going to be updated.
name	string Name of the registry. There may be only one registry per folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
labels	map<string,string> Resource labels as key:value pairs. Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateRegistryMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Registry> if operation finished successfully.

UpdateRegistryMetadata

Field	Description
registry_id	string ID of the Registry resource that is being updated.

Registry

Field	Description
id	string Output only. ID of the registry.
folder_id	string ID of the folder that the registry belongs to.
name	string Name of the registry.
status	enum Status Output only. Status of the registry. CREATING: Registry is being created. ACTIVE: Registry is ready to use. DELETING: Registry is being deleted.
created_at	google.protobuf.Timestamp Output only. Creation timestamp in RFC3339 text format.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

Delete

Deletes the specified registry.

rpc Delete (DeleteRegistryRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteRegistryMetadata

    Operation.response:google.protobuf.Empty

DeleteRegistryRequest

Field	Description
registry_id	string Required. ID of the registry to delete. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteRegistryMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteRegistryMetadata

Field	Description
registry_id	string ID of the registry that is being deleted.

ListAccessBindings

Lists access bindings for the specified registry.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource to list access bindings for. To get the resource ID, use a corresponding List request. For example, use the yandex.cloud.resourcemanager.v1.CloudService.List request to get the Cloud resource ID. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100.

ListAccessBindingsResponse

Field	Description
access_bindings[]	AccessBinding List of access bindings for the specified resource.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

AccessBinding

Field	Description
role_id	string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

Subject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the type is userAccount, federatedUser or serviceAccount. The maximum string length in characters is 50.
type	string Required. Type of the subject. It can contain one of the following values: userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud. serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

SetAccessBindings

Sets access bindings for the specified registry.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

SetAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource for which access bindings are being set. To get the resource ID, use a corresponding List request. The maximum string length in characters is 50.
access_bindings[]	AccessBinding Required. Access bindings to be set. For more information, see Access Bindings.

AccessBinding

Field	Description
role_id	string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

Subject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the type is userAccount, federatedUser or serviceAccount. The maximum string length in characters is 50.
type	string Required. Type of the subject. It can contain one of the following values: userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud. serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<SetAccessBindingsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

SetAccessBindingsMetadata

Field	Description
resource_id	string ID of the resource for which access bindings are being set.

UpdateAccessBindings

Updates access bindings for the specified registry.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50.
access_binding_deltas[]	AccessBindingDelta Required. Updates to access bindings. The number of elements must be greater than 0.

AccessBindingDelta

Field	Description
action	enum AccessBindingAction Required. The action that is being performed on an access binding. ADD: Addition of an access binding. REMOVE: Removal of an access binding.
access_binding	AccessBinding Required. Access binding. For more information, see Access Bindings.

AccessBinding

Field	Description
role_id	string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

Subject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the type is userAccount, federatedUser or serviceAccount. The maximum string length in characters is 50.
type	string Required. Type of the subject. It can contain one of the following values: userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud. serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateAccessBindingsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

UpdateAccessBindingsMetadata

Field	Description
resource_id	string ID of the resource for which access bindings are being updated.

ListIpPermission

List ip permissions for the specified registry.

rpc ListIpPermission (ListIpPermissionRequest) returns (ListIpPermissionsResponse)

ListIpPermissionRequest

Field	Description
registry_id	string Required. ID of the Registry to return ip permission list. The maximum string length in characters is 50.

ListIpPermissionsResponse

Field	Description
permissions[]	IpPermission List of ip permissions for registry

IpPermission

Field	Description
action	enum Action
ip	string

SetIpPermission

Set ip permissions for the specified registry.

rpc SetIpPermission (SetIpPermissionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetIpPermissionMetadata

    Operation.response:google.protobuf.Empty

SetIpPermissionRequest

Field	Description
registry_id	string Required. ID of the registry for which ip permissions are being set. The maximum string length in characters is 50.
ip_permission[]	IpPermission IP permission to be set.

IpPermission

Field	Description
action	enum Action
ip	string

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<SetIpPermissionMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

SetIpPermissionMetadata

Field	Description
registry_id	string ID of the registry that ip permission is being set.

UpdateIpPermission

Update ip permissions for the specified registry.

rpc UpdateIpPermission (UpdateIpPermissionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateIpPermissionMetadata

    Operation.response:google.protobuf.Empty

UpdateIpPermissionRequest

Field	Description
registry_id	string Required. ID of the registry for which ip permissions are being updated. The maximum string length in characters is 50.
ip_permission_deltas[]	IpPermissionDelta Updates to IP permissions.

IpPermissionDelta

Field	Description
action	enum IpPermissionAction Required. The action that is being performed on an ip permission. ADD: Addition of an ip permission. REMOVE: Removal of an ip permission.
ip_permission	IpPermission Required. Ip permission.

IpPermission

Field	Description
action	enum Action
ip	string

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateIpPermissionMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

UpdateIpPermissionMetadata

Field	Description
registry_id	string ID of the registry that ip permission is being updated.