Reverse Private Endpoint 조회

이 endpoint는 베타입니다. API 계약은 안정적이며, 앞으로 호환되지 않는 변경 사항은 없을 것으로 예상됩니다.

지정된 ID의 Reverse Private Endpoint를 반환합니다.

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

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
}

인증

Authorization · string · header · 필수

ClickHouse Cloud 콘솔에서 발급받은 key ID와 key secret을 사용합니다: https://clickhouse.com/docs/cloud/manage/openapi

경로 매개변수

organizationId · string<uuid> · 필수

해당 service를 소유한 organization의 ID.

serviceId · string<uuid> · 필수

해당 Reverse Private Endpoint를 소유한 service의 ID.

reversePrivateEndpointId · string<uuid> · 필수

조회할 Reverse Private Endpoint의 ID.

응답

200

application/json

성공 응답

requestId · string<uuid>

모든 요청에 할당되는 고유 ID입니다. UUIDv4

result · object

Show child attributes

status · number

HTTP 상태 코드.

예시:

200