Create reverse private endpoint

Create a new reverse private endpoint.

POST /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints

Create reverse private endpoint

cURL

curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "My reverse private endpoint",
  "type": "VPC_ENDPOINT_SERVICE",
  "vpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567",
  "vpcResourceConfigurationId": "rcfg-12345678901234567",
  "vpcResourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567",
  "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster/a1b2c3d4-5678-90ab-cdef-1234567890ab-1",
  "mskAuthentication": "SASL_IAM",
  "gcpServiceAttachment": "projects/my-project/regions/us-central1/serviceAttachments/my-service",
  "customPrivateDnsMappings": [
    {
      "privateDnsName": "my-service.example.com"
    },
    {
      "privateDnsName": "*.example.com"
    }
  ]
}
'

200

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "description": "My reverse private endpoint",
    "type": "VPC_ENDPOINT_SERVICE",
    "vpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567",
    "vpcResourceConfigurationId": "rcfg-12345678901234567",
    "vpcResourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567",
    "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster/a1b2c3d4-5678-90ab-cdef-1234567890ab-1",
    "mskAuthentication": "SASL_IAM",
    "gcpServiceAttachment": "projects/my-project/regions/us-central1/serviceAttachments/my-service",
    "customPrivateDnsMappings": [
      {
        "privateDnsName": "my-service.example.com"
      },
      {
        "privateDnsName": "*.example.com"
      }
    ],
    "id": "12345678-1234-1234-1234-123456789012",
    "serviceId": "12345678-1234-1234-1234-123456789012",
    "endpointId": "vpce-12345678901234567",
    "dnsNames": [
      "vpce-12345678901234567-abcdefg.execute-api.us-east-1.vpce.amazonaws.com"
    ],
    "privateDnsNames": [
      "vpce-12345678901234567-abcdefg.execute-api.us-east-1.vpce.amazonaws.com"
    ],
    "privateDnsMappings": [
      {
        "privateDnsName": "my-service.example.com",
        "internalDnsName": "internal.example.com"
      }
    ],
    "dnsTargets": [
      {
        "id": "rcfg-097648d8068504966",
        "kind": "RESOURCE_CONFIGURATION",
        "internalDnsName": "internal.example.com"
      }
    ],
    "status": "Ready"
  }
}

Create a new reverse private endpoint.

​

Permission

The API key must have the control-plane:service:manage-clickpipes permission.

Autorizaciones

Authorization · string · header · requerido

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId · string<uuid> · requerido

ID of the organization that owns the service.

serviceId · string<uuid> · requerido

ID of the service that owns the Reverse Private Endpoint.

Cuerpo

application/json

description · string · requerido

Reverse private endpoint description. Maximum length is 255 characters.

Ejemplo:

"My reverse private endpoint"

type · enum<string> · requerido

Reverse private endpoint type.

Opciones disponibles: VPC_ENDPOINT_SERVICE, VPC_RESOURCE, MSK_MULTI_VPC, GCP_PSC_SERVICE_ATTACHMENT

Ejemplo:

"VPC_ENDPOINT_SERVICE"

vpcEndpointServiceName · string

VPC endpoint service name.

Ejemplo:

"com.amazonaws.vpce.us-east-1.vpce-svc-12345678901234567"

vpcResourceConfigurationId · string

VPC resource configuration ID. Required for VPC_RESOURCE type.

Ejemplo:

"rcfg-12345678901234567"

vpcResourceShareArn · string

VPC resource share ARN. Required for VPC_RESOURCE type.

Ejemplo:

"arn:aws:ram:us-east-1:123456789012:resource-share/share-12345678901234567"

mskClusterArn · string

MSK cluster ARN. Required for MSK_MULTI_VPC type.

Ejemplo:

"arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster/a1b2c3d4-5678-90ab-cdef-1234567890ab-1"

mskAuthentication · enum<string>

MSK cluster authentication type. Required for MSK_MULTI_VPC type.

Opciones disponibles: SASL_IAM, SASL_SCRAM

Ejemplo:

"SASL_IAM"

gcpServiceAttachment · string

Private Preview. GCP PSC service attachment URI. Required for GCP_PSC_SERVICE_ATTACHMENT type. Format: projects/{project}/regions/{region}/serviceAttachments/{name}.

Ejemplo:

"projects/my-project/regions/us-central1/serviceAttachments/my-service"

customPrivateDnsMappings · object[]

Optional private DNS names for Reverse Private Endpoint. Can be used as data source destination address. Must be unique across the ClickHouse service. Generally available for Google Private Service Connect (PSC). For AWS PrivateLink (VPC endpoint service and VPC resource), available in Private Preview; contact ClickHouse support to enable it for your service. Not supported for MSK multi-VPC. Supports exact names and leading wildcard names such as *.example.com

Show child attributes

Ejemplo:

[
  {
    "privateDnsName": "my-service.example.com"
  },
  { "privateDnsName": "*.example.com" }
]

Respuesta

200

application/json

Successful response

status · number

HTTP status code.

Ejemplo:

200

requestId · string<uuid>

Unique id assigned to every request. UUIDv4

result · object

Show child attributes