ApiGatewayService
Набор методов управления API-шлюзами.
Вызов | Описание |
---|---|
Get | Возвращает указанный API-шлюз. |
List | Возвращает список API-шлюзов в указанном каталоге. |
Create | Создает API-шлюз в указанном каталоге. |
Update | Изменяет указанный API-шлюз. |
Delete | Удаляет указанный API-шлюз. |
GetOpenapiSpec | Возвращает спецификацию OpenAPI указанного API-шлюза. |
ListOperations | Возвращает список операции для указанного API-шлюза. |
ListAccessBindings | Возвращает список привязок прав доступа для указанного API-шлюза. |
SetAccessBindings | Задает список привязок прав доступа для указанного API-шлюза. |
UpdateAccessBindings | Обновляет привязки прав доступа для указанного API-шлюза. |
Вызовы ApiGatewayService
Get
Возвращает указанный API-шлюз. Обратите внимание, что возвращаются только базовые параметры API-шлюза. Чтобы получить соответствующую спецификацию OpenAPI, сделайте GetOpenapiSpec запрос.
Чтобы получить список всех доступных API-шлюзов, сделайте List запрос.
rpc Get (GetApiGatewayRequest) returns (ApiGateway)
GetApiGatewayRequest
Поле | Описание |
---|---|
api_gateway_id | string Обязательное поле. Идентификатор возвращаемого API-шлюза. Чтобы получить идентификатор API-шлюза, сделайте ApiGatewayService.List запрос. |
ApiGateway
Поле | Описание |
---|---|
id | string Идентификатор API-шлюза. Генерируется при создании. |
folder_id | string Идентификатор каталога, которому принадлежит API-шлюз. |
created_at | google.protobuf.Timestamp Время создания API-шлюза. |
name | string Имя API-шлюза. Имя уникально в рамках каталога. |
description | string Описание API-шлюза. |
labels | map<string,string> Метки API-шлюза в формате key:value . |
status | enum Status Состояние API-шлюза.
|
domain | string Домен по умолчанию для API-шлюза. Генерируется при создании. |
log_group_id | string Идентификатор группы журналов выполнения для API-шлюза. |
List
Возвращает список API-шлюзов в указанном каталоге.
rpc List (ListApiGatewayRequest) returns (ListApiGatewayResponse)
ListApiGatewayRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка API-шлюзов. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение ListApiGatewayResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListApiGatewayResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. |
filter | string
|
ListApiGatewayResponse
Поле | Описание |
---|---|
api_gateways[] | ApiGateway Возвращает список API-шлюзов в указанном каталоге. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListApiGatewayRequest.page_size, используйте nextPageToken в качестве значения параметра ListApiGatewayRequest.page_token в следующем запросе списка ресурсов. Каждая следующая страница будет иметь свой nextPageToken для продолжения перебора страниц результатов. |
ApiGateway
Поле | Описание |
---|---|
id | string Идентификатор API-шлюза. Генерируется при создании. |
folder_id | string Идентификатор каталога, которому принадлежит API-шлюз. |
created_at | google.protobuf.Timestamp Время создания API-шлюза. |
name | string Имя API-шлюза. Имя уникально в рамках каталога. |
description | string Описание API-шлюза. |
labels | map<string,string> Метки API-шлюза в формате key:value . |
status | enum Status Состояние API-шлюза.
|
domain | string Домен по умолчанию для API-шлюза. Генерируется при создании. |
log_group_id | string Идентификатор группы журналов выполнения для API-шлюза. |
Create
Создает API-шлюз в указанном каталоге.
rpc Create (CreateApiGatewayRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateApiGatewayMetadata
Operation.response:ApiGateway
CreateApiGatewayRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для создания API-шлюза. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
name | string Имя API-шлюза. Имя должно быть уникальным в рамках каталога. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание API-шлюза. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате key:value . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
spec | oneof: openapi_spec OpenAPI спецификация API-шлюза. |
openapi_spec | string Текст спецификации, JSON или YAML. |
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<CreateApiGatewayMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<ApiGateway> в случае успешного выполнения операции. |
CreateApiGatewayMetadata
Поле | Описание |
---|---|
api_gateway_id | string Идентификатор создаваемого API-шлюза. |
ApiGateway
Поле | Описание |
---|---|
id | string Идентификатор API-шлюза. Генерируется при создании. |
folder_id | string Идентификатор каталога, которому принадлежит API-шлюз. |
created_at | google.protobuf.Timestamp Время создания API-шлюза. |
name | string Имя API-шлюза. Имя уникально в рамках каталога. |
description | string Описание API-шлюза. |
labels | map<string,string> Метки API-шлюза в формате key:value . |
status | enum Status Состояние API-шлюза.
|
domain | string Домен по умолчанию для API-шлюза. Генерируется при создании. |
log_group_id | string Идентификатор группы журналов выполнения для API-шлюза. |
Update
Изменяет указанный API-шлюз.
rpc Update (UpdateApiGatewayRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateApiGatewayMetadata
Operation.response:ApiGateway
UpdateApiGatewayRequest
Поле | Описание |
---|---|
api_gateway_id | string Обязательное поле. Идентификатор API-шлюза для обновления. Чтобы получить идентификатор API-шлюза, сделайте ApiGatewayService.List запрос. |
update_mask | google.protobuf.FieldMask Маска поля, указывающая, какие атрибуты API-шлюза должны быть обновлены. |
name | string Новое имя для API-шлюза. Имя должно быть уникальным в рамках каталога. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Новое описание для API-шлюза. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки API-шлюза в формате key:value . Существующий набор меток полностью заменяется предоставленным набором, поэтому, если вы просто хотите добавить или удалить метку, запросите текущий набор меток, используя запрос ApiGatewayService.Get . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
spec | oneof: openapi_spec OpenAPI спецификация API-шлюза. |
openapi_spec | string Текст спецификации, JSON или YAML. |
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<UpdateApiGatewayMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<ApiGateway> в случае успешного выполнения операции. |
UpdateApiGatewayMetadata
Поле | Описание |
---|---|
api_gateway_id | string Идентификатор обновляемого API-шлюза. |
ApiGateway
Поле | Описание |
---|---|
id | string Идентификатор API-шлюза. Генерируется при создании. |
folder_id | string Идентификатор каталога, которому принадлежит API-шлюз. |
created_at | google.protobuf.Timestamp Время создания API-шлюза. |
name | string Имя API-шлюза. Имя уникально в рамках каталога. |
description | string Описание API-шлюза. |
labels | map<string,string> Метки API-шлюза в формате key:value . |
status | enum Status Состояние API-шлюза.
|
domain | string Домен по умолчанию для API-шлюза. Генерируется при создании. |
log_group_id | string Идентификатор группы журналов выполнения для API-шлюза. |
Delete
Удаляет указанный API-шлюз.
rpc Delete (DeleteApiGatewayRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteApiGatewayMetadata
Operation.response:google.protobuf.Empty
DeleteApiGatewayRequest
Поле | Описание |
---|---|
api_gateway_id | string Обязательное поле. Идентификатор API-шлюза для обновления. Чтобы получить идентификатор API-шлюза, сделайте ApiGatewayService.List запрос. |
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<DeleteApiGatewayMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
DeleteApiGatewayMetadata
Поле | Описание |
---|---|
api_gateway_id | string Идентификатор удаляемого API-шлюза. |
GetOpenapiSpec
Возвращает спецификацию OpenAPI указанного API-шлюза.
rpc GetOpenapiSpec (GetOpenapiSpecRequest) returns (GetOpenapiSpecResponse)
GetOpenapiSpecRequest
Поле | Описание |
---|---|
api_gateway_id | string Обязательное поле. Идентификатор API-шлюза для получения спецификации. |
format | enum Format Формат возвращаемой спецификации. По умолчанию используется исходный формат, используемый в CreateApiGatewayRequest. |
GetOpenapiSpecResponse
Поле | Описание |
---|---|
api_gateway_id | string Идентификатор API-шлюза. |
openapi_spec | string Текст спецификации, JSON или YAML. |
ListOperations
Возвращает список операции для указанного API-шлюза.
rpc ListOperations (ListOperationsRequest) returns (ListOperationsResponse)
ListOperationsRequest
Поле | Описание |
---|---|
api_gateway_id | string Обязательное поле. Идентификатор API-шлюза для получения списка операций. |
page_size | int64 Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем pageSize , сервис вернет значение ListOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение pageToken равным значению поля ListOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Возвращает список операции для указанного API-шлюза. |
next_page_token | string Токен для получения следующей страницы списка. Если количество результатов больше чем ListOperationsRequest.page_size, используйте nextPageToken в качестве значения параметра ListOperationsRequest.page_token в следующем запросе списка ресурсов. Каждая следующая страница будет иметь свой nextPageToken для продолжения перебора страниц результатов. |
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 Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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 Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response . |
ListAccessBindings
Возвращает список привязок прав доступа для указанного API-шлюза.
rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)
ListAccessBindingsRequest
Поле | Описание |
---|---|
resource_id | string Обязательное поле. Идентификатор ресурса, для которого запрашивается список привязок прав доступа. Чтобы получить идентификатор ресурса, используйте соответствующий запрос List. Например, используйте запрос yandex.cloud.resourcemanager.v1.CloudService.List для получения идентификатора ресурса Cloud. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size , сервис вернет значение ListAccessBindingsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListAccessBindingsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListAccessBindingsResponse
Поле | Описание |
---|---|
access_bindings[] | AccessBinding Список привязок прав доступа для указанного ресурса. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListAccessBindingsRequest.page_size, используйте next_page_token в качестве значения параметра ListAccessBindingsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
AccessBinding
Поле | Описание |
---|---|
role_id | string Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject . Максимальная длина строки в символах — 50. |
subject | Subject Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором. |
Subject
Поле | Описание |
---|---|
id | string Обязательное поле.
|
type | string Обязательное поле.
|
SetAccessBindings
Задает список привязок прав доступа для указанного API-шлюза.
rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:SetAccessBindingsMetadata
Operation.response:google.protobuf.Empty
SetAccessBindingsRequest
Поле | Описание |
---|---|
resource_id | string Обязательное поле. Идентификатор ресурса, для которого задается список привязок прав доступа. Чтобы получить идентификатор ресурса, используйте соответствующий запрос List. Максимальная длина строки в символах — 50. |
access_bindings[] | AccessBinding Обязательное поле. Привязки прав доступа, которые будут установлены. Дополнительные сведения см. в разделе Привязка прав доступа. |
AccessBinding
Поле | Описание |
---|---|
role_id | string Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject . Максимальная длина строки в символах — 50. |
subject | Subject Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором. |
Subject
Поле | Описание |
---|---|
id | string Обязательное поле.
|
type | string Обязательное поле.
|
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<SetAccessBindingsMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
SetAccessBindingsMetadata
Поле | Описание |
---|---|
resource_id | string Идентификатор ресурса, для которого задается список привязок прав доступа. |
UpdateAccessBindings
Обновляет привязки прав доступа для указанного API-шлюза.
rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateAccessBindingsMetadata
Operation.response:google.protobuf.Empty
UpdateAccessBindingsRequest
Поле | Описание |
---|---|
resource_id | string Обязательное поле. Идентификатор ресурса, для которого обновляется список привязок прав доступа. Максимальная длина строки в символах — 50. |
access_binding_deltas[] | AccessBindingDelta Обязательное поле. Изменения в список привязок прав доступа. Количество элементов должно быть больше 0. |
AccessBindingDelta
Поле | Описание |
---|---|
action | enum AccessBindingAction Обязательное поле. Действие, которое надо выполнить с привязкой прав доступа.
|
access_binding | AccessBinding Обязательное поле. Привязка прав доступа. Дополнительные сведения см. в разделе Привязка прав доступа. |
AccessBinding
Поле | Описание |
---|---|
role_id | string Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject . Максимальная длина строки в символах — 50. |
subject | Subject Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором. |
Subject
Поле | Описание |
---|---|
id | string Обязательное поле.
|
type | string Обязательное поле.
|
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<UpdateAccessBindingsMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
UpdateAccessBindingsMetadata
Поле | Описание |
---|---|
resource_id | string Идентификатор ресурса, для которого обновляется список привязок прав доступа. |