Reverse Private Endpoint を一覧表示

このエンドポイントはベータです。 API コントラクトは安定しており、今後破壊的変更が発生する予定はありません。

指定したサービスの Reverse Private Endpoint の一覧を返します。

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

Reverse Private Endpoint を一覧表示

cURL

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints \
  --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> · 必須

サービスを所有する組織の ID。

serviceId · string<uuid> · 必須

Reverse Private Endpoint を所有するサービスの ID。

レスポンス

200

application/json

成功レスポンス

requestId · string<uuid>

各リクエストに割り当てられる一意の ID。UUIDv4

result · object[]

Show child attributes

status · number

HTTP ステータスコード。

例:

200