Virtual Private Cloud API, gRPC: PrivateEndpointService.Update
Updates the specified private endpoint.
gRPC request
rpc Update (UpdatePrivateEndpointRequest) returns (operation.Operation)
UpdatePrivateEndpointRequest
{
"privateEndpointId": "string",
"updateMask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"labels": "string",
"addressSpec": {
// Includes only one of the fields `addressId`, `internalIpv4AddressSpec`
"addressId": "string",
"internalIpv4AddressSpec": {
"subnetId": "string",
"address": "string"
}
// end of the list of possible fields
},
"dnsOptions": {
"privateDnsRecordsEnabled": "bool"
}
}
Field |
Description |
privateEndpointId |
string Required field. ID of the private endpoint to update. To get the private endpoint ID make a PrivateEndpointService.List |
updateMask |
Field mask that specifies which attributes of the PrivateEndpoint should be |
name |
string New name for the private endpoint. |
description |
string New description of the private endpoint. |
labels |
string Private endpoint labels as Existing set of labels is completely replaced by the provided set, so if
|
addressSpec |
Private endpoint address specification. |
dnsOptions |
Private endpoint dns options. |
AddressSpec
Field |
Description |
addressId |
string ID of IP address to associate with private endpoint. Includes only one of the fields |
internalIpv4AddressSpec |
Internal ipv4 address specification. Includes only one of the fields |
InternalIpv4AddressSpec
Field |
Description |
subnetId |
string Required field. ID of the subnet that address belongs to. |
address |
string Value of address. |
DnsOptions
Field |
Description |
privateDnsRecordsEnabled |
bool If enabled - vpc will create private dns records for specified service. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"privateEndpointId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"networkId": "string",
"status": "Status",
"address": {
"subnetId": "string",
"address": "string",
"addressId": "string"
},
"dnsOptions": {
"privateDnsRecordsEnabled": "bool"
},
// Includes only one of the fields `objectStorage`
"objectStorage": "ObjectStorage"
// end of the list of possible fields
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdatePrivateEndpointMetadata
Field |
Description |
privateEndpointId |
string ID of the private endpoint that is being updated. |
PrivateEndpoint
Field |
Description |
id |
string ID of the private endpoint. Generated at creation time. |
folderId |
string ID of the folder that the private endpoint belongs to. |
createdAt |
Creation timestamp. |
name |
string Name of the private endpoint. |
description |
string Description of the private endpoint. 0-256 characters long. |
labels |
string Private endpoint labels as |
networkId |
string ID of the network that the private endpoint belongs to. |
status |
enum Status Status of the private endpoint.
|
address |
Private endpoint ip address details. |
dnsOptions |
Private endpoint dns options. |
objectStorage |
Yandex Cloud Object Storage. Includes only one of the fields Service to connect with via private endpoint. |
EndpointAddress
Private endpoint ip address details.
Field |
Description |
subnetId |
string ID of the subnet that the private endpoint address belongs to. |
address |
string IP address of the private endpoint. |
addressId |
string ID of the private endpoint address. |
DnsOptions
Field |
Description |
privateDnsRecordsEnabled |
bool If enabled - vpc will create private dns records for specified service. |
ObjectStorage
Yandex Cloud Object Storage.
Field |
Description |
Empty |