AccessKeyService

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

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

Вызовы AccessKeyService

List

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

rpc List (ListAccessKeysRequest) returns (ListAccessKeysResponse)

ListAccessKeysRequest

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

ListAccessKeysResponse

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

AccessKey

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

Get

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

rpc Get (GetAccessKeyRequest) returns (AccessKey)

GetAccessKeyRequest

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

AccessKey

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

Create

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

rpc Create (CreateAccessKeyRequest) returns (CreateAccessKeyResponse)

CreateAccessKeyRequest

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

CreateAccessKeyResponse

Поле	Описание
access_key	AccessKey Ресурс AccessKey.
secret	string Секретный ключ доступа. Ключ совместим с сервисами AWS.

AccessKey

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

Update

Обновляет указанный ключ доступа.

rpc Update (UpdateAccessKeyRequest) returns (operation.Operation)

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

    Operation.metadata:UpdateAccessKeyMetadata

    Operation.response:AccessKey

UpdateAccessKeyRequest

Поле	Описание
access_key_id	string Обязательное поле. Идентификатор обновляемого ресурса AccessKey. Чтобы получить идентификатор ключа доступа, используйте запрос AccessKeyService.List. Максимальная длина строки в символах — 50.
update_mask	google.protobuf.FieldMask Маска, определяющая, какие поля ресурса AccessKey будут обновлены.
description	string Описание ключа доступа. Максимальная длина строки в символах — 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<UpdateAccessKeyMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<AccessKey> в случае успешного выполнения операции.

UpdateAccessKeyMetadata

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

AccessKey

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

Delete

Удаляет указанный ключ доступа.

rpc Delete (DeleteAccessKeyRequest) returns (operation.Operation)

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

    Operation.metadata:DeleteAccessKeyMetadata

    Operation.response:google.protobuf.Empty

DeleteAccessKeyRequest

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

DeleteAccessKeyMetadata

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

ListOperations

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

rpc ListOperations (ListAccessKeyOperationsRequest) returns (ListAccessKeyOperationsResponse)

ListAccessKeyOperationsRequest

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

ListAccessKeyOperationsResponse

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