Obtenir le Reverse Private Endpoint

Cet endpoint est en bêta. Le contrat d’API est stable et aucune breaking change n’est attendue à l’avenir.

Renvoie le Reverse Private Endpoint avec l’ID spécifié.

GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}

Obtenir le Reverse Private Endpoint

cURL

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId} \
  --header 'Authorization: Basic <encoded-value>'

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
}

Autorisations

Authorization · string · header · requis

Utilisez l’ID de la clé et le secret de la clé obtenus dans la ClickHouse Cloud console : https://clickhouse.com/docs/cloud/manage/openapi

Paramètres de chemin

organizationId · string<uuid> · requis

ID de l’organisation propriétaire du service.

serviceId · string<uuid> · requis

ID du service propriétaire du Reverse Private Endpoint.

reversePrivateEndpointId · string<uuid> · requis

ID du Reverse Private Endpoint à récupérer.

Réponse

200

application/json

Réponse réussie

requestId · string<uuid>

Identifiant unique attribué à chaque requête. UUIDv4

result · object

Show child attributes

status · number

Code d’état HTTP.

Exemple:

200