---
title: "PATCH /v1/{+name}"
method: PATCH
path: "/v1/{+name}"
tags: ["projects"]
---

# PATCH /v1/{+name}

`PATCH /v1/{+name}`

Updates the parameters of a single ServiceConnectionMap.

## Path parameters

- `name` string, required

## Query parameters

- `requestId` string
- `updateMask` string

## Request body

- ServiceConnectionMap — The ServiceConnectionMap resource.
  - `labels` object — User-defined labels.
  - `consumerPscConnections` ConsumerPscConnection[] — Output only. PSC connection details on consumer side.
    - `project` string — The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
    - `gceOperation` string — The last Compute Engine operation to setup PSC connection.
    - `producerInstanceMetadata` object — Immutable. An immutable map for the producer instance metadata.
    - `network` string — The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).
    - `forwardingRule` string — The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
    - `ipVersion` 'IP_VERSION_UNSPECIFIED' | 'IPV4' | 'IPV6' — The requested IP version for the PSC connection.
    - `ip` string — The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
    - `dnsAutomationStatus` DnsAutomationStatus — The status of DNS automation for a PSC connection.
      - `error` GoogleRpcStatus — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
        - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use.
        - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
        - `code` integer — The status code, which should be an enum value of google.rpc.Code.
      - `state` 'STATE_UNSPECIFIED' | 'PENDING_CREATE' | 'ACTIVE' | 'PENDING_DELETE' | 'CREATE_FAILED' | 'DELETE_FAILED' — Output only. The current state of DNS automation.
      - `fqdn` string — Output only. The fully qualified domain name of the DNS record.
    - `errorType` 'CONNECTION_ERROR_TYPE_UNSPECIFIED' | 'ERROR_INTERNAL' | 'ERROR_CONSUMER_SIDE' | 'ERROR_PRODUCER_SIDE' — The error type indicates whether the error is consumer facing, producer facing or system internal.
    - `producerInstanceId` string — Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.
    - `error` GoogleRpcStatus — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use.
      - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      - `code` integer — The status code, which should be an enum value of google.rpc.Code.
    - `selectedSubnetwork` string — Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
    - `state` 'STATE_UNSPECIFIED' | 'ACTIVE' | 'FAILED' | 'CREATING' | 'DELETING' | 'CREATE_REPAIRING' | 'DELETE_REPAIRING' — The state of the PSC connection.
    - `errorInfo` GoogleRpcErrorInfo — Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
      - `domain` string — The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
      - `reason` string — The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
      - `metadata` object — Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
    - `serviceAttachmentUri` string — The URI of a service attachment which is the target of the PSC connection.
    - `pscConnectionId` string — The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
  - `createTime` string, google-datetime — Output only. Time when the ServiceConnectionMap was created.
  - `description` string — A description of this resource.
  - `producerPscConfigs` ProducerPscConfig[] — The PSC configurations on producer side.
    - `serviceAttachmentUri` string — The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.
    - `automatedDnsCreationSpec` AutomatedDnsCreationSpec — The specification for automatically creating a DNS record.
      - `ttl` string, google-duration — Optional. The Time To Live for the DNS record, in seconds. If not provided, a default of 30 seconds will be used.
      - `dnsSuffix` string — Required. The DNS suffix to use for the DNS record. Must end with a dot. This should be a valid DNS domain name as per RFC 1035. Each label (between dots) can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-service.example.com.", "internal."
      - `hostname` string — Required. The hostname (the first label of the FQDN) to use for the DNS record. This should be a valid DNS label as per RFC 1035. Generally, this means the hostname can contain letters, digits, and hyphens, and must not start or end with a hyphen. Example: "my-instance", "db-1"
  - `infrastructure` 'INFRASTRUCTURE_UNSPECIFIED' | 'PSC' — Output only. The infrastructure used for connections between consumers/producers.
  - `consumerPscConfigs` ConsumerPscConfig[] — The PSC configurations on consumer side.
    - `disableGlobalAccess` boolean — This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
    - `state` 'STATE_UNSPECIFIED' | 'VALID' | 'CONNECTION_POLICY_MISSING' | 'POLICY_LIMIT_REACHED' | 'CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED' — Output only. Overall state of PSC Connections management for this consumer psc config.
    - `consumerInstanceProject` string — Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234'
    - `serviceAttachmentIpAddressMap` object — Optional. A map to store mapping between customer vip and target service attachment. This field can be used to specify a static IP address for a PSC connection.
    - `producerInstanceId` string — Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.
    - `ipVersion` 'IP_VERSION_UNSPECIFIED' | 'IPV4' | 'IPV6' — The requested IP version for the PSC connection.
    - `network` string — The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.
    - `project` string — The consumer project where PSC connections are allowed to be created in.
    - `producerInstanceMetadata` object — Immutable. An immutable map for the producer instance metadata.
  - `etag` string — Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  - `serviceClassUri` string — Output only. The service class uri this ServiceConnectionMap is for.
  - `name` string — Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
  - `updateTime` string, google-datetime — Output only. Time when the ServiceConnectionMap was updated.
  - `serviceClass` string — The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
  - `token` string — The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/networkconnectivity.md) · [All operations](https://skmtc.net/google/apis/networkconnectivity/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/networkconnectivity/versions/778637dee420/schema)