Method: organizations.locations.customers.workloads.getEkmConnections

Gets the EKM connections associated with a workload

HTTP request

GET https://cloudcontrolspartner.googleapis.com/v1beta/{name=organizations/*/locations/*/customers/*/workloads/*/ekmConnections}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections

Request body

The request body must be empty.

Response body

The EKM connections associated with a workload

If successful, the response body contains data with the following structure:

JSON representation 
{
  "name": string,
  "ekmConnections": [
    {
      object (EkmConnection)
    }
  ]
}
Fields
name

string

Identifier. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
ekmConnections[]

object (EkmConnection)

The EKM connections associated with the workload

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • cloudcontrolspartner.ekmconnections.get

For more information, see the IAM documentation.

EkmConnection

Details about the EKM connection

JSON representation 
{
  "connectionName": string,
  "connectionState": enum (ConnectionState),
  "connectionError": {
    object (ConnectionError)
  }
}
Fields
connectionName

string

Resource name of the EKM connection in the format: projects/{project}/locations/{location}/ekmConnections/{ekm_connection}
connectionState

enum (ConnectionState)

Output only. The connection state
connectionError

object (ConnectionError)

The connection error that occurred if any

ConnectionState

The EKM connection state.

Enums
CONNECTION_STATE_UNSPECIFIED Unspecified EKM connection state
AVAILABLE Available EKM connection state
NOT_AVAILABLE Not available EKM connection state
ERROR Error EKM connection state
PERMISSION_DENIED Permission denied EKM connection state

ConnectionError

Information around the error that occurred if the connection state is anything other than available or unspecified

JSON representation 
{
  "errorDomain": string,
  "errorMessage": string
}
Fields
errorDomain

string

The error domain for the error
errorMessage

string

The error message for the error