Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Cloud DNS

DnsZoneService

Статья создана

A set of methods for managing DNS zones.

Call Description
Get Returns the specified DNS zone.
List Retrieves the list of DNS zones in the specified folder.
Create Creates a DNS zone in the specified folder.
Update Updates the specified DNS zone.
Delete Deletes the specified DNS zone.
GetRecordSet Returns the specified record set.
ListRecordSets Retrieves the list of record sets in the specified folder.
UpdateRecordSets Method with strict control for changing zone state.
UpsertRecordSets Method without strict control for changing zone state.
ListOperations Lists operations for the specified DNS zone.
ListAccessBindings Lists existing access bindings for the specified DNS zone.
SetAccessBindings Sets access bindings for the specified DNS zone.
UpdateAccessBindings Updates access bindings for the specified DNS zone.

Calls DnsZoneService

Get

Returns the specified DNS zone.
To get the list of all available DNS zones, make a List request.

rpc Get (GetDnsZoneRequest) returns (DnsZone)

GetDnsZoneRequest

Field Description
dns_zone_id string
Required. ID of the DNS zone to return.
To get a DNS zone ID, make a DnsZoneService.List request.

DnsZone

Field Description
id string
ID of the DNS zone. Generated at creation time.
folder_id string
ID of the folder that the DNS zone belongs to.
created_at google.protobuf.Timestamp
Creation timestamp.
name string
Name of the DNS zone. The name is unique within the folder.
description string
Description of the DNS zone.
labels map<string,string>
DNS zone labels as key:value pairs.
zone string
DNS zone suffix.
private_visibility PrivateVisibility
Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only.
public_visibility PublicVisibility
Publicly visible zone settings. Indicates whether records within the zone are publicly visible.

PrivateVisibility

Field Description
network_ids[] string
Network IDs. The number of elements must be in the range 0-10. The string length in characters for each value must be equal to 20.

PublicVisibility

List

Retrieves the list of DNS zones in the specified folder.

rpc List (ListDnsZonesRequest) returns (ListDnsZonesResponse)

ListDnsZonesRequest

Field Description
folder_id string
Required. ID of the folder to list DNS zones in.
To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.
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 ListDnsZonesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token string
Page token. To get the next page of results, set page_token to the ListDnsZonesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 1000.
filter string
A filter expression that filters DNS zones listed in the response.
The expression must specify:
  1. The field name. Currently you can use filtering only on the DnsZone.name field.
  2. An = operator.
  3. 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].
Example of a filter: name=my-dns-zone. The maximum string length in characters is 1000.

ListDnsZonesResponse

Field Description
dns_zones[] DnsZone
List of DNS zones in the specified folder.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListDnsZonesRequest.page_size, use next_page_token as the value for the ListDnsZonesRequest.page_token parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

DnsZone

Field Description
id string
ID of the DNS zone. Generated at creation time.
folder_id string
ID of the folder that the DNS zone belongs to.
created_at google.protobuf.Timestamp
Creation timestamp.
name string
Name of the DNS zone. The name is unique within the folder.
description string
Description of the DNS zone.
labels map<string,string>
DNS zone labels as key:value pairs.
zone string
DNS zone suffix.
private_visibility PrivateVisibility
Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only.
public_visibility PublicVisibility
Publicly visible zone settings. Indicates whether records within the zone are publicly visible.

PrivateVisibility

Field Description
network_ids[] string
Network IDs. The number of elements must be in the range 0-10. The string length in characters for each value must be equal to 20.

PublicVisibility

Create

Creates a DNS zone in the specified folder.

rpc Create (CreateDnsZoneRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateDnsZoneMetadata

    Operation.response:DnsZone

CreateDnsZoneRequest

Field Description
folder_id string
Required. ID of the folder to create DNS zones in.
To get a folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name string
Name of the DNS zone. The name must be unique within the folder. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
Description of the DNS zone. The maximum string length in characters is 256.
labels map<string,string>
DNS zone 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]*.
zone string
Required. DNS zone suffix. The maximum string length in characters is 255. Value must match the regular expression [.]|[a-z0-9][-a-z0-9.]*\\..
private_visibility PrivateVisibility
Privately visible zone settings. At least one of two visibility fields must be set.
public_visibility PublicVisibility
Publicly visible zone settings. At least one of two visibility fields must be set.

PrivateVisibility

Field Description
network_ids[] string
Network IDs. The number of elements must be in the range 0-10. The string length in characters for each value must be equal to 20.

PublicVisibility

Operation

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

CreateDnsZoneMetadata

Field Description
dns_zone_id string
ID of the DNS zone that is being created.

DnsZone

Field Description
id string
ID of the DNS zone. Generated at creation time.
folder_id string
ID of the folder that the DNS zone belongs to.
created_at google.protobuf.Timestamp
Creation timestamp.
name string
Name of the DNS zone. The name is unique within the folder.
description string
Description of the DNS zone.
labels map<string,string>
DNS zone labels as key:value pairs.
zone string
DNS zone suffix.
private_visibility PrivateVisibility
Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only.
public_visibility PublicVisibility
Publicly visible zone settings. Indicates whether records within the zone are publicly visible.

PrivateVisibility

Field Description
network_ids[] string
Network IDs. The number of elements must be in the range 0-10. The string length in characters for each value must be equal to 20.

PublicVisibility

Update

Updates the specified DNS zone.

rpc Update (UpdateDnsZoneRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateDnsZoneMetadata

    Operation.response:DnsZone

UpdateDnsZoneRequest

Field Description
dns_zone_id string
ID of the DNS zone to update.
To get the DNS zone ID, make a DnsZoneService.List request. The string length in characters must be equal to 20.
update_mask google.protobuf.FieldMask
Field mask specifying which fields of the DNS zone resource are going to be updated.
name string
New name for the DNS zone. The name must be unique within the folder. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
New description of the DNS zone. The maximum string length in characters is 256.
labels map<string,string>
DNS zone labels as key:value pairs.
Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label:
  1. Get the current set of labels with a DnsZoneService.Get request.
  2. Add or remove a label in this set.
  3. Send the new set in this field.
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]*.
private_visibility PrivateVisibility
Change network IDs for private visibility.
public_visibility PublicVisibility
Public visibility configuration.

PrivateVisibility

Field Description
network_ids[] string
Network IDs. The number of elements must be in the range 0-10. The string length in characters for each value must be equal to 20.

PublicVisibility

Operation

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

UpdateDnsZoneMetadata

Field Description
dns_zone_id string
ID of the DNS zone that is being updated.

DnsZone

Field Description
id string
ID of the DNS zone. Generated at creation time.
folder_id string
ID of the folder that the DNS zone belongs to.
created_at google.protobuf.Timestamp
Creation timestamp.
name string
Name of the DNS zone. The name is unique within the folder.
description string
Description of the DNS zone.
labels map<string,string>
DNS zone labels as key:value pairs.
zone string
DNS zone suffix.
private_visibility PrivateVisibility
Privately visible zone settings. Specifies whether records within the zone are visible from a VPC networks only.
public_visibility PublicVisibility
Publicly visible zone settings. Indicates whether records within the zone are publicly visible.

PrivateVisibility

Field Description
network_ids[] string
Network IDs. The number of elements must be in the range 0-10. The string length in characters for each value must be equal to 20.

PublicVisibility

Delete

Deletes the specified DNS zone.

rpc Delete (DeleteDnsZoneRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteDnsZoneMetadata

    Operation.response:google.protobuf.Empty

DeleteDnsZoneRequest

Field Description
dns_zone_id string
ID of the DNS zone to delete.
To get a DNS zone ID, make a DnsZoneService.List request. The string length in characters must be equal to 20.

Operation

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

DeleteDnsZoneMetadata

Field Description
dns_zone_id string
ID of the DNS zone that is being deleted.

GetRecordSet

Returns the specified record set.

rpc GetRecordSet (GetDnsZoneRecordSetRequest) returns (RecordSet)

GetDnsZoneRecordSetRequest

Field Description
dns_zone_id string
ID of the DNS zone to get record set from.
To get a DNS zone ID, make a DnsZoneService.List request. The string length in characters must be equal to 20.
name string
Required. Name of the record set. The maximum string length in characters is 255.
type string
Required. Type of the record set. The maximum string length in characters is 10.

RecordSet

Field Description
name string
Domain name. The string length in characters must be 1-254.
type string
Record type. The string length in characters must be 1-20.
ttl int64
Time to live in seconds. Acceptable values are 0 to 2147483647, inclusive.
data[] string
Data of the record set. The number of elements must be in the range 1-100. The string length in characters for each value must be 1-255.

ListRecordSets

Retrieves the list of record sets in the specified folder.

rpc ListRecordSets (ListDnsZoneRecordSetsRequest) returns (ListDnsZoneRecordSetsResponse)

ListDnsZoneRecordSetsRequest

Field Description
dns_zone_id string
ID of the DNS zone to list record sets in.
To get a DNS zone ID, make a DnsZoneService.List request. The string length in characters must be equal to 20.
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 ListDnsZoneRecordSetsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token string
Page token. To get the next page of results, set page_token to the ListDnsZoneRecordSetsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 1000.
filter string
A filter expression that filters record sets listed in the response. The expression consists of one or more conditions united by AND operator: <condition1> [AND <condition2> [<...> AND <conditionN>]].
Each condition has the form <field> <operator> <value>, where:
  1. <field> is the field name. Currently you can use filtering only on the RecordSet.name and RecordSet.type fields.
  2. <operator> is a logical operator, one of =, !=, IN, NOT IN.
  3. <value> represents a value.
3.1. In case of single value condition (= or !=), the value is a string in double (") or single (') quotes. C-style escape sequences are supported (\" turns to ", \' to ', \\ to backslash). 3.2. In case of a list of values condition (IN or NOT IN), the value is (<string1>, <string2>, .., <stringN>), where <string> is a string in double (") or single (') quotes.
Examples of a filter: name="my-record-set", type IN ("MX","A") AND name="works.on.my.machine.". The maximum string length in characters is 1000.

ListDnsZoneRecordSetsResponse

Field Description
record_sets[] RecordSet
List of record sets in the specified DNS zone.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListDnsZoneRecordSetsRequest.page_size, use next_page_token as the value for the ListDnsZoneRecordSetsRequest.page_token parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

RecordSet

Field Description
name string
Domain name. The string length in characters must be 1-254.
type string
Record type. The string length in characters must be 1-20.
ttl int64
Time to live in seconds. Acceptable values are 0 to 2147483647, inclusive.
data[] string
Data of the record set. The number of elements must be in the range 1-100. The string length in characters for each value must be 1-255.

UpdateRecordSets

Method with strict control for changing zone state. Returns error when:

  1. Deleted record is not found.
  2. Found record with matched type and name but different TTL or value.
  3. Attempted to add record with existing name and type.
Deletions happen first. If a record with the same name and type exists in both lists, then the existing record will be deleted, and a new one added.

rpc UpdateRecordSets (UpdateRecordSetsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateRecordSetsMetadata

    Operation.response:google.protobuf.Empty

UpdateRecordSetsRequest

Field Description
dns_zone_id string
ID of the DNS zone to update record sets in.
To get a DNS zone ID, make a DnsZoneService.List request. The string length in characters must be equal to 20.
deletions[] RecordSet
List of record sets to delete. The maximum number of elements is 1000.
additions[] RecordSet
List of record sets to add. The maximum number of elements is 1000.

RecordSet

Field Description
name string
Domain name. The string length in characters must be 1-254.
type string
Record type. The string length in characters must be 1-20.
ttl int64
Time to live in seconds. Acceptable values are 0 to 2147483647, inclusive.
data[] string
Data of the record set. The number of elements must be in the range 1-100. The string length in characters for each value must be 1-255.

Operation

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

UpdateRecordSetsMetadata

UpsertRecordSets

Method without strict control for changing zone state. Nothing happens if deleted record doesn't exist. Deletes records that match all specified fields which allows to delete only specified records from a record set.

rpc UpsertRecordSets (UpsertRecordSetsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpsertRecordSetsMetadata

    Operation.response:google.protobuf.Empty

UpsertRecordSetsRequest

Field Description
dns_zone_id string
ID of the DNS zone to upsert record sets to.
To get a DNS zone ID, make a DnsZoneService.List request. The string length in characters must be equal to 20.
deletions[] RecordSet
Delete only specified records from corresponding record sets. The maximum number of elements is 1000.
replacements[] RecordSet
Entirely replace specified record sets. The maximum number of elements is 1000.
merges[] RecordSet
Replace specified records or add new ones if no such record sets exists. The maximum number of elements is 1000.

RecordSet

Field Description
name string
Domain name. The string length in characters must be 1-254.
type string
Record type. The string length in characters must be 1-20.
ttl int64
Time to live in seconds. Acceptable values are 0 to 2147483647, inclusive.
data[] string
Data of the record set. The number of elements must be in the range 1-100. The string length in characters for each value must be 1-255.

Operation

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

UpsertRecordSetsMetadata

ListOperations

Lists operations for the specified DNS zone.

rpc ListOperations (ListDnsZoneOperationsRequest) returns (ListDnsZoneOperationsResponse)

ListDnsZoneOperationsRequest

Field Description
dns_zone_id string
ID of the DNS zone to list operations for.
To get a DNS zone ID, make a DnsZoneService.List request. The string length in characters must be equal to 20.
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 ListDnsZoneOperationsResponse.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.
page_token string
Page token. To get the next page of results, set page_token to the ListDnsZoneOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 1000.
filter string
A filter expression that filters DNS zones listed in the response.
The expression must specify:
  1. The field name. Currently you can use filtering only on the DnsZone.name field.
  2. An = operator.
  3. 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].
Example of a filter: name=my-dns-zone. The maximum string length in characters is 1000.

ListDnsZoneOperationsResponse

Field Description
operations[] operation.Operation
List of operations for the specified DNS zone.
next_page_token string
Token for getting the next page of the list. If the number of results is greater than the specified ListDnsZoneOperationsRequest.page_size, use next_page_token as the value for the ListDnsZoneOperationsRequest.page_token parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

Operation

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.

ListAccessBindings

Lists existing access bindings for the specified DNS zone.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequest

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.

ListAccessBindingsResponse

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.

AccessBinding

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.

Subject

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.

SetAccessBindings

Sets access bindings for the specified DNS zone.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

SetAccessBindingsRequest

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.

AccessBinding

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.

Subject

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.

Operation

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<google.protobuf.Empty>
if operation finished successfully.

SetAccessBindingsMetadata

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

UpdateAccessBindings

Updates access bindings for the specified DNS zone.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequest

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.

AccessBindingDelta

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.

AccessBinding

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.

Subject

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.

Operation

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<google.protobuf.Empty>
if operation finished successfully.

UpdateAccessBindingsMetadata

Field Description
resource_id string
ID of the resource for which access bindings are being updated.
Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье: