Cloud Router API, gRPC: RoutingInstanceService.Update

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

Обновлена 21 февраля 2025 г.

gRPC request
UpdateRoutingInstanceRequest
VpcInfo
VpcAzInfo
VpcManualInfo
CicPrivateConnectionInfo
operation.Operation
UpdateRoutingInstanceMetadata
RoutingInstance
VpcInfo
VpcAzInfo
VpcManualInfo
CicPrivateConnectionInfo

Updates a RoutingInstance resource using the data specified in the request.
Method starts an asynchronous operation that can be cancelled while it is in progress.

gRPC request

rpc Update (UpdateRoutingInstanceRequest) returns (operation.Operation)

UpdateRoutingInstanceRequest

{
  "routing_instance_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "region_id": "string",
  "vpc_info": [
    {
      "vpc_network_id": "string",
      "az_infos": [
        {
          "manual_info": {
            "az_id": "string",
            "prefixes": [
              "string"
            ]
          }
        }
      ]
    }
  ],
  "cic_private_connection_info": [
    {
      "cic_private_connection_id": "string"
    }
  ],
  "labels": "map<string, string>"
}

Field	Description
routing_instance_id	string Required field. ID of the RoutingInstance resource to return.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the RoutingInstance resource are going to be updated.
name	string Name of the RoutingInstance. The name must be unique within the folder. Value must match the regular expression `\\\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?`.
description	string Optional description of the RoutingInstance. 0-256 characters long.
region_id	string ID of the region that the routingInstance belongs to.
vpc_info[]	VpcInfo List of the info about vpcNetworks which are attached to the RoutingInstance.
cic_private_connection_info[]	CicPrivateConnectionInfo List of the info about privateConnections which are attached to the RoutingInstance.
labels	object (map<string, string>) Resource labels, `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]`.

VpcInfo

Field

Description

vpc_network_id

string

ID of the vpcNetwork that is attached to the routingInstance.

az_infos[]

VpcAzInfo

List of the az-related info about vpcNetworks which are attached to routingInstance

VpcAzInfo

Field

Description

manual_info

VpcManualInfo

VpcInfo which is set by user

VpcManualInfo

Field

Description

az_id

string

ID of the AZ

prefixes[]

string

List of prefixes to announce

CicPrivateConnectionInfo

Field

Description

cic_private_connection_id

string

ID of the cicPrivateConnection that is attached to the routingInstance.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "routing_instance_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "folder_id": "string",
    "region_id": "string",
    "vpc_info": [
      {
        "vpc_network_id": "string",
        "az_infos": [
          {
            "manual_info": {
              "az_id": "string",
              "prefixes": [
                "string"
              ]
            }
          }
        ]
      }
    ],
    "cic_private_connection_info": [
      {
        "cic_private_connection_id": "string"
      }
    ],
    "status": "Status",
    "created_at": "google.protobuf.Timestamp",
    "labels": "map<string, string>"
  }
  // 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.
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	UpdateRoutingInstanceMetadata 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `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.
response	RoutingInstance 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. Includes only one of the fields `error`, `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.

UpdateRoutingInstanceMetadata

Field

Description

routing_instance_id

string

ID of the RoutingInstance resource.

RoutingInstance

Field	Description
id	string ID of the routingInstance.
name	string Name of the routingInstance. The name must be unique within the folder. Value must match the regular expression `\\\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?`.
description	string Optional description of the routingInstance. 0-256 characters long.
folder_id	string ID of the folder that the routingInstance belongs to.
region_id	string ID of the region that the routingInstance belongs to.
vpc_info[]	VpcInfo List of the info about vpcNetworks which are attached to routingInstance.
cic_private_connection_info[]	CicPrivateConnectionInfo List of the info about privateConnections which are attached to routingInstance.
status	enum Status Status of the routingInstance. `STATUS_UNSPECIFIED` `CREATING` `UPDATING` `DELETING` `ACTIVE`
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format.
labels	object (map<string, string>) Resource labels, `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]`.

VpcInfo

Field

Description

vpc_network_id

string

ID of the vpcNetwork that is attached to the routingInstance.

az_infos[]

VpcAzInfo

List of the az-related info about vpcNetworks which are attached to routingInstance

VpcAzInfo

Field

Description

manual_info

VpcManualInfo

VpcInfo which is set by user

VpcManualInfo

Field

Description

az_id

string

ID of the AZ

prefixes[]

string

List of prefixes to announce

CicPrivateConnectionInfo

Field

Description

cic_private_connection_id

string

ID of the cicPrivateConnection that is attached to the routingInstance.

Cloud Router API, gRPC: RoutingInstanceService.Update

gRPC requestgRPC request

UpdateRoutingInstanceRequestUpdateRoutingInstanceRequest

VpcInfoVpcInfo

VpcAzInfoVpcAzInfo

VpcManualInfoVpcManualInfo

CicPrivateConnectionInfoCicPrivateConnectionInfo

operation.Operationoperation.Operation

UpdateRoutingInstanceMetadataUpdateRoutingInstanceMetadata

RoutingInstanceRoutingInstance

VpcInfoVpcInfo

VpcAzInfoVpcAzInfo

VpcManualInfoVpcManualInfo

CicPrivateConnectionInfoCicPrivateConnectionInfo

Была ли статья полезна?

gRPC request

UpdateRoutingInstanceRequest

VpcInfo

VpcAzInfo

VpcManualInfo

CicPrivateConnectionInfo

operation.Operation

UpdateRoutingInstanceMetadata

RoutingInstance

VpcInfo

VpcAzInfo

VpcManualInfo

CicPrivateConnectionInfo