ClickPipes
List reverse private endpoints
Returns a list of reverse private endpoints for the specified service.
get/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints
Request
- Base URL: https://api.clickhouse.cloud
- URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints
- Auth: HTTP basic
Path parameters
organizationIdstring uuid required
ID of the organization that owns the service.
serviceIdstring uuid required
ID of the service that owns the Reverse Private Endpoint.
Response
Successful response
Example response
{
"status": 200,
"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"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.