ApiKeyService

Набор методов управления API-ключами.

Вызов	Описание
List	Возвращает список API-ключей для указанного сервисного аккаунта.
Get	Возвращает указанный API-ключ.
Create	Создает API-ключ для указанного сервисного аккаунта.
Update	Обновляет указанный API-ключ.
Delete	Удаляет указанный API-ключ.
ListOperations	Возвращает список операций для указанного API ключа.

Вызовы ApiKeyService

List

Возвращает список API-ключей для указанного сервисного аккаунта.

rpc List (ListApiKeysRequest) returns (ListApiKeysResponse)

ListApiKeysRequest

Поле	Описание
service_account_id	string Идентификатор сервисного аккаунта, для которого запрашивается список API-ключей. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. Если параметр не указан, то используется идентификатор субъекта, который сделал запрос. Максимальная длина строки в символах — 50.
page_size	int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListApiKeysResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
page_token	string Токен страницы. Установите значение page_token равным значению поля ListApiKeysResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

ListApiKeysResponse

Поле	Описание
api_keys[]	ApiKey Список API-ключей.
next_page_token	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListApiKeysRequest.page_size, используйте next_page_token в качестве значения параметра ListApiKeysRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

ApiKey

Поле	Описание
id	string Идентификатор API-ключа.
service_account_id	string Идентификатор сервисного аккаунта, которому принадлежит API-ключ.
created_at	google.protobuf.Timestamp Время создания.
description	string Описание API-ключа. Длина описания должна быть от 0 до 256 символов.

Get

Возвращает указанный API-ключ.
Чтобы получить список доступных API-ключ, используйте запрос List.

rpc Get (GetApiKeyRequest) returns (ApiKey)

GetApiKeyRequest

Поле	Описание
api_key_id	string Обязательное поле. Идентификатор возвращаемого API-ключа. Чтобы получить идентификатор ключа, используйте запрос ApiKeyService.List. Максимальная длина строки в символах — 50.

ApiKey

Поле	Описание
id	string Идентификатор API-ключа.
service_account_id	string Идентификатор сервисного аккаунта, которому принадлежит API-ключ.
created_at	google.protobuf.Timestamp Время создания.
description	string Описание API-ключа. Длина описания должна быть от 0 до 256 символов.

Create

Создает API-ключ для указанного сервисного аккаунта.

rpc Create (CreateApiKeyRequest) returns (CreateApiKeyResponse)

CreateApiKeyRequest

Поле	Описание
service_account_id	string Идентификатор сервисного аккаунта для создания API-ключа. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. Если параметр не указан, то используется идентификатор субъекта, который сделал запрос. Максимальная длина строки в символах — 50.
description	string Описание API-ключа. Максимальная длина строки в символах — 256.

CreateApiKeyResponse

Поле	Описание
api_key	ApiKey Ресурс ApiKey.
secret	string Секретная часть API-ключа. Этот секретный ключ можно использовать для аутентификации при запросах.

ApiKey

Поле	Описание
id	string Идентификатор API-ключа.
service_account_id	string Идентификатор сервисного аккаунта, которому принадлежит API-ключ.
created_at	google.protobuf.Timestamp Время создания.
description	string Описание API-ключа. Длина описания должна быть от 0 до 256 символов.

Update

Обновляет указанный API-ключ.

rpc Update (UpdateApiKeyRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:UpdateApiKeyMetadata

    Operation.response:ApiKey

UpdateApiKeyRequest

Поле	Описание
api_key_id	string Обязательное поле. Идентификатор обновляемого ресурса ApiKey. Чтобы получить идентификатор API-ключа, используйте запрос ApiKeyService.List. Максимальная длина строки в символах — 50.
update_mask	google.protobuf.FieldMask Маска, определяющая, какие поля ресурса ApiKey будут обновлены.
description	string Описание API-ключа. Максимальная длина строки в символах — 256.

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<UpdateApiKeyMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<ApiKey> в случае успешного выполнения операции.

UpdateApiKeyMetadata

Поле	Описание
api_key_id	string Идентификатор изменяемого ресурса ApiKey.

ApiKey

Поле	Описание
id	string Идентификатор API-ключа.
service_account_id	string Идентификатор сервисного аккаунта, которому принадлежит API-ключ.
created_at	google.protobuf.Timestamp Время создания.
description	string Описание API-ключа. Длина описания должна быть от 0 до 256 символов.

Delete

Удаляет указанный API-ключ.

rpc Delete (DeleteApiKeyRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:DeleteApiKeyMetadata

    Operation.response:google.protobuf.Empty

DeleteApiKeyRequest

Поле	Описание
api_key_id	string Обязательное поле. Идентификатор ключа, который следует удалить. Чтобы получить идентификатор ключа, используйте запрос ApiKeyService.List. Максимальная длина строки в символах — 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<DeleteApiKeyMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции.

DeleteApiKeyMetadata

Поле	Описание
api_key_id	string Идентификатор удаляемого API-ключа.

ListOperations

Возвращает список операций для указанного API ключа.

rpc ListOperations (ListApiKeyOperationsRequest) returns (ListApiKeyOperationsResponse)

ListApiKeyOperationsRequest

Поле	Описание
api_key_id	string Обязательное поле. Идентификатор API-ключа, для которого требуется получть список операций. Максимальная длина строки в символах — 50.
page_size	int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListApiKeyOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
page_token	string Токен страницы. Установите значение page_token равным значению поля ListApiKeyOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

ListApiKeyOperationsResponse

Поле	Описание
operations[]	operation.Operation Список операций для указанного API-ключа.
next_page_token	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListApiKeyOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListApiKeyOperationsRequest.page_token в следующем запросе списка API-ключей. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

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.