Resource Manager API, gRPC: CloudService

A set of methods for managing Cloud resources.

Call	Description
Get	Returns the specified Cloud resource.
List	Retrieves the list of Cloud resources.
Create	Creates a cloud in the specified organization.
Update	Updates the specified cloud.
Delete	Deletes the specified cloud.
ListOperations	Lists operations for the specified cloud.
ListAccessBindings	Lists access bindings for the specified cloud.
SetAccessBindings	Sets access bindings for the specified cloud.
UpdateAccessBindings	Updates access bindings for the specified cloud.

Calls CloudServiceCalls CloudService

GetGet

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

rpc Get (GetCloudRequest) returns (Cloud)

GetCloudRequestGetCloudRequest

Field	Description
cloud_id	string Required. ID of the Cloud resource to return. To get the cloud ID, use a CloudService.List request. The maximum string length in characters is 50.

CloudCloud

Field	Description
id	string ID of the cloud.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the cloud. 3-63 characters long.
description	string Description of the cloud. 0-256 characters long.
organization_id	string ID of the organization that the cloud belongs to.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

ListList

Retrieves the list of Cloud resources.

rpc List (ListCloudsRequest) returns (ListCloudsResponse)

ListCloudsRequestListCloudsRequest

Field	Description
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 ListCloudsResponse.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 ListCloudsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 2000.
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 the Cloud.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.
organization_id	string ID of the organization to list clouds in. To get the organization ID, use a yandex.cloud.organizationmanager.v1.OrganizationService.List request. The maximum string length in characters is 50.

ListCloudsResponseListCloudsResponse

Field	Description
clouds[]	Cloud List of Cloud 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 ListCloudsRequest.page_size, use the next_page_token as the value for the ListCloudsRequest.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.

CloudCloud

Field	Description
id	string ID of the cloud.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the cloud. 3-63 characters long.
description	string Description of the cloud. 0-256 characters long.
organization_id	string ID of the organization that the cloud belongs to.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

CreateCreate

Creates a cloud in the specified organization.

rpc Create (CreateCloudRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateCloudMetadata

    Operation.response:Cloud

CreateCloudRequestCreateCloudRequest

Field	Description
organization_id	string Required. ID of the organization to create a cloud in. To get the organization ID, use a yandex.cloud.organizationmanager.v1.OrganizationService.List request. The maximum string length in characters is 50.
name	string Required. Name of the cloud. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
description	string Description of the cloud. The maximum string length in characters is 256.
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]*.

OperationOperation

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<CreateCloudMetadata> 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<Cloud> if operation finished successfully.

CreateCloudMetadataCreateCloudMetadata

Field	Description
cloud_id	string ID of the cloud that is being created.

CloudCloud

Field	Description
id	string ID of the cloud.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the cloud. 3-63 characters long.
description	string Description of the cloud. 0-256 characters long.
organization_id	string ID of the organization that the cloud belongs to.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

UpdateUpdate

Updates the specified cloud.

rpc Update (UpdateCloudRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateCloudMetadata

    Operation.response:Cloud

UpdateCloudRequestUpdateCloudRequest

Field	Description
cloud_id	string Required. ID of the cloud to update. To get the cloud ID, use a CloudService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the cloud are going to be updated.
name	string Name of the cloud. Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description	string Description of the cloud. The maximum string length in characters is 256.
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]*.

OperationOperation

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<UpdateCloudMetadata> 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<Cloud> if operation finished successfully.

UpdateCloudMetadataUpdateCloudMetadata

Field	Description
cloud_id	string ID of the cloud that is being updated.

CloudCloud

Field	Description
id	string ID of the cloud.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the cloud. 3-63 characters long.
description	string Description of the cloud. 0-256 characters long.
organization_id	string ID of the organization that the cloud belongs to.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.

DeleteDelete

Deletes the specified cloud.

rpc Delete (DeleteCloudRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteCloudMetadata

    Operation.response:google.protobuf.Empty

DeleteCloudRequestDeleteCloudRequest

Field	Description
cloud_id	string Required. ID of the cloud to delete. To get the cloud ID, use a CloudService.List request. The maximum string length in characters is 50.
delete_after	google.protobuf.Timestamp The timestamp after which the process of deleting the cloud should begin. Until this timestamp, the cloud goes into the PENDING_DELETION state and all resources in this cloud are stopped. In this state, it is possible to cancel the delete operation without any loss. After this timestamp, the status of the cloud will become DELETING and the process of deleting all the resources of the cloud will be started. If delete_after is not specified it will be (now + 24 hours). To initiate an immediate deletion delete_after must be <= now.

OperationOperation

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<DeleteCloudMetadata> 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.

DeleteCloudMetadataDeleteCloudMetadata

Field	Description
cloud_id	string ID of the cloud that is being deleted.
delete_after	google.protobuf.Timestamp The timestamp after which the process of deleting the cloud should begin.
cancelled_by	string Information about operation cancellation
cancelled_at	google.protobuf.Timestamp

ListOperationsListOperations

Lists operations for the specified cloud.

rpc ListOperations (ListCloudOperationsRequest) returns (ListCloudOperationsResponse)

ListCloudOperationsRequestListCloudOperationsRequest

Field	Description
cloud_id	string Required. ID of the Cloud resource to list operations for. 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 ListCloudOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. The maximum value is 1000.
page_token	string Page token. Set page_token to the ListCloudOperationsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 2000.

ListCloudOperationsResponseListCloudOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified cloud.
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 ListCloudOperationsRequest.page_size, use the next_page_token as the value for the ListCloudOperationsRequest.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.

OperationOperation

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 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 The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

ListAccessBindingsListAccessBindings

Lists access bindings for the specified cloud.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequestListAccessBindingsRequest

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.

ListAccessBindingsResponseListAccessBindingsResponse

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.

AccessBindingAccessBinding

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.

SubjectSubject

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.

SetAccessBindingsSetAccessBindings

Sets access bindings for the specified cloud.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:AccessBindingsOperationResult

SetAccessBindingsRequestSetAccessBindingsRequest

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.

AccessBindingAccessBinding

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.

SubjectSubject

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.

OperationOperation

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<AccessBindingsOperationResult> if operation finished successfully.

SetAccessBindingsMetadataSetAccessBindingsMetadata

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

UpdateAccessBindingsUpdateAccessBindings

Updates access bindings for the specified cloud.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:AccessBindingsOperationResult

UpdateAccessBindingsRequestUpdateAccessBindingsRequest

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.

AccessBindingDeltaAccessBindingDelta

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.

AccessBindingAccessBinding

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.

SubjectSubject

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.

OperationOperation

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<AccessBindingsOperationResult> if operation finished successfully.

UpdateAccessBindingsMetadataUpdateAccessBindingsMetadata

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