RegistryService
Набор методов для управления ресурсами Registry.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс Registry. |
List | Возвращает список доступных ресурсов Registry в указанном каталоге. |
Create | Создает реестр в указанном каталоге. |
Update | Обновляет указанный реестр. |
Delete | Удаляет указанный реестр. |
Вызовы RegistryService
Get
Возвращает указанный ресурс Registry.
Чтобы получить список доступных ресурсов Registry, используйте запрос List.
rpc Get (GetRegistryRequest) returns (Registry)
GetRegistryRequest
Поле | Описание |
---|---|
registry_id | string Обязательное поле. Идентификатор возвращаемого ресурса Registry. Чтобы получить идентификатор реестра, используйте запрос RegistryService.List. Максимальная длина строки в символах — 50. |
Registry
Поле | Описание |
---|---|
id | string Только для вывода. Идентификатор реестра. |
folder_id | string Идентификатор каталога, которому принадлежит реестр. |
name | string Название реестра. |
status | enum Status Только для вывода. Статус реестра.
|
created_at | google.protobuf.Timestamp Только для вывода. Время создания ресурса в формате RFC3339. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
List
Возвращает список доступных ресурсов Registry в указанном каталоге.
rpc List (ListRegistriesRequest) returns (ListRegistriesResponse)
ListRegistriesRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка реестров. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListRegistriesResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListRegistriesResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListRegistriesResponse
Поле | Описание |
---|---|
registries[] | Registry Список ресурсов Registry. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListRegistriesRequest.page_size, используйте next_page_token в качестве значения параметра ListRegistriesRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Registry
Поле | Описание |
---|---|
id | string Только для вывода. Идентификатор реестра. |
folder_id | string Идентификатор каталога, которому принадлежит реестр. |
name | string Название реестра. |
status | enum Status Только для вывода. Статус реестра.
|
created_at | google.protobuf.Timestamp Только для вывода. Время создания ресурса в формате RFC3339. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
Create
Создает реестр в указанном каталоге.
rpc Create (CreateRegistryRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateRegistryMetadata
Operation.response:Registry
CreateRegistryRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, в котором создается реестр. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
name | string Название реестра. Может быть только один реестр в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
labels | map<string,string> Метки ресурса в формате key:value . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateRegistryMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Registry> в случае успешного выполнения операции. |
CreateRegistryMetadata
Поле | Описание |
---|---|
registry_id | string Идентификатор создаваемого реестра. |
Registry
Поле | Описание |
---|---|
id | string Только для вывода. Идентификатор реестра. |
folder_id | string Идентификатор каталога, которому принадлежит реестр. |
name | string Название реестра. |
status | enum Status Только для вывода. Статус реестра.
|
created_at | google.protobuf.Timestamp Только для вывода. Время создания ресурса в формате RFC3339. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
Update
Обновляет указанный реестр.
rpc Update (UpdateRegistryRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateRegistryMetadata
Operation.response:Registry
UpdateRegistryRequest
Поле | Описание |
---|---|
registry_id | string Обязательное поле. Идентификатор изменяемого ресурса Registry. Чтобы получить идентификатор реестра, используйте запрос RegistryService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, определяющая, какие поля ресурса Registry будут обновлены. |
name | string Название реестра. Может быть только один реестр в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
labels | map<string,string> Метки ресурса в формате key:value . Существующий набор labels полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateRegistryMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Registry> в случае успешного выполнения операции. |
UpdateRegistryMetadata
Поле | Описание |
---|---|
registry_id | string Идентификатор изменяемого ресурса Registry. |
Registry
Поле | Описание |
---|---|
id | string Только для вывода. Идентификатор реестра. |
folder_id | string Идентификатор каталога, которому принадлежит реестр. |
name | string Название реестра. |
status | enum Status Только для вывода. Статус реестра.
|
created_at | google.protobuf.Timestamp Только для вывода. Время создания ресурса в формате RFC3339. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
Delete
Удаляет указанный реестр.
rpc Delete (DeleteRegistryRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteRegistryMetadata
Operation.response:google.protobuf.Empty
DeleteRegistryRequest
Поле | Описание |
---|---|
registry_id | string Обязательное поле. Идентификатор удаляемого реестра. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteRegistryMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteRegistryMetadata
Поле | Описание |
---|---|
registry_id | string Идентификатор удаляемого реестра. |