Crear Reverse Private Endpoint

Este endpoint está en beta. El contrato de la API es estable y no se esperan cambios incompatibles en el futuro.

Crea un nuevo reverse private endpoint.

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

Crear 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",
  "mskAuthentication": "SASL_IAM",
  "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster",
  "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"
}
'

200

{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "description": "My reverse private endpoint",
    "dnsNames": [
      "<string>"
    ],
    "endpointId": "vpce-12345678901234567",
    "id": "12345678-1234-1234-1234-123456789012",
    "mskAuthentication": "SASL_IAM",
    "mskClusterArn": "arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster",
    "privateDnsNames": [
      "<string>"
    ],
    "serviceId": "12345678-1234-1234-1234-123456789012",
    "status": "Ready",
    "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"
  },
  "status": 200
}

Autorizaciones

Authorization · string · header · requerido

Usa el ID de la clave y el secreto de la clave obtenidos en la consola de ClickHouse Cloud: https://clickhouse.com/docs/cloud/manage/openapi

Parámetros de ruta

organizationId · string<uuid> · requerido

ID de la organización propietaria del servicio.

serviceId · string<uuid> · requerido

ID del servicio propietario del Reverse Private Endpoint.

Cuerpo

application/json

description · string

Descripción del endpoint privado inverso. La longitud máxima es de 255 caracteres.

Ejemplo:

"My reverse private endpoint"

mskAuthentication · enum<string> | null

Tipo de autenticación del clúster de MSK. Obligatorio para el tipo MSK_MULTI_VPC.

Opciones disponibles: SASL_IAM, SASL_SCRAM

Ejemplo:

"SASL_IAM"

mskClusterArn · string | null

ARN del clúster de MSK. Obligatorio para el tipo MSK_MULTI_VPC.

Ejemplo:

"arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster"

type · enum<string>

Tipo de endpoint privado inverso.

Opciones disponibles: VPC_ENDPOINT_SERVICE, VPC_RESOURCE, MSK_MULTI_VPC

Ejemplo:

"VPC_ENDPOINT_SERVICE"

vpcEndpointServiceName · string | null

Nombre del servicio del endpoint de VPC.

Ejemplo:

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

vpcResourceConfigurationId · string | null

ID de configuración del recurso de VPC. Obligatorio para el tipo VPC_RESOURCE.

Ejemplo:

"rcfg-12345678901234567"

vpcResourceShareArn · string | null

ARN del recurso compartido de VPC. Obligatorio para el tipo VPC_RESOURCE.

Ejemplo:

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

Respuesta

200

application/json

Respuesta correcta

requestId · string<uuid>

ID único asignado a cada solicitud. UUIDv4

result · object

Show child attributes

status · number

Código de estado HTTP.

Ejemplo:

200