---
title: "Read a Network Link Service Association"
method: GET
path: "/networking/v1/network-link-service-associations/{id}"
tags: ["Network Link Service Associations (networking/v1)"]
---

# Read a Network Link Service Association

`GET /networking/v1/network-link-service-associations/{id}`

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Make a request to read a network link service association.

## Path parameters

- `id` string, required

## Query parameters

- `spec.network_link_service` string, required — Filter a collection by a string search
- `environment` string, required — Filter a collection by a string search

## Response `200`

Network Link Service Association.

- object — List of incoming Network Link Enpoints associated with the Network Link Service. Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/current/networking/network-linking.html). ## The Network Link Service Associations Model <SchemaDefinition schemaRef="#/components/schemas/networking.v1.NetworkLinkServiceAssociation" />
  - `api_version` 'networking/v1', required — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'NetworkLinkServiceAssociation', required — Kind defines the object this REST resource represents.
  - `id` string, required — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
  - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
    - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
    - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
    - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
    - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
    - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
  - `spec` object, required — The desired state of the Network Link Service Association
    - `display_name` string, required — The name of the network link endpoint
    - `description` string — The description of the network link endpoint
    - `network_link_endpoint` string, required — ID of the Network link endpoint.
    - `network_link_service` object, required — The network_link_service to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
    - `environment` object, required — The environment to which this belongs.
      - `id` string, required — ID of the referred resource
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
  - `status` NetworkingV1NetworkLinkServiceAssociationStatus, required — The status of the Network Link Service Association
    - `phase` string, required — The lifecycle phase of the network link endpoint: PROVISIONING: network link endpoint provisioning is in progress; PENDING_ACCEPT: network link endpoint request is pending acceptance by the the owner of the target; READY: network link endpoint is ready; FAILED: network link endpoint is in a failed state; DEPROVISIONING: network link endpoint deprovisioning is in progress; EXPIRED: network link endpoint request is expired, can only be deleted; DISCONNECTED: network link endpoint is in a disconnected state, target owner has removed the permissions; DISCONNECTING: network link endpoint disconnection is in progress; INACTIVE: network link endpoint is created, but not active since there are no clusters in the network;
    - `error_code` string — Error code if network link is in a failed state. May be used for programmatic error checking.
    - `error_message` string — Displayable error message if network link is in a failed state
    - `expires_at` string, date-time — The date and time when the request expires if it is not accepted by the target network admin.

## Other responses

- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `404` — Not Found
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/confluent/apis/confluent-cloud-apis/revisions/cd93f933f941?raw)
