Reverse Private Endpoint を作成

この endpoint はベータです。 API コントラクトは安定しており、今後 breaking changes が発生することはない見込みです。

新しい Reverse Private Endpoint を作成します。

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

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
}

承認

Authorization · string · header · 必須

ClickHouse Cloud console で取得した key ID と key secret を使用してください: https://clickhouse.com/docs/cloud/manage/openapi

パスパラメータ

organizationId · string<uuid> · 必須

service を所有する組織の ID。

serviceId · string<uuid> · 必須

Reverse Private Endpoint を所有する service の ID。

ボディ

application/json

description · string

Reverse private endpoint の説明。最大長は 255 文字です。

例:

"My reverse private endpoint"

mskAuthentication · enum<string> | null

MSK クラスターの認証タイプ。MSK_MULTI_VPC タイプでは必須です。

利用可能なオプション: SASL_IAM, SASL_SCRAM

例:

"SASL_IAM"

mskClusterArn · string | null

MSK cluster ARN。MSK_MULTI_VPC タイプで必須です。

例:

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

type · enum<string>

Reverse private endpoint のタイプ。

利用可能なオプション: VPC_ENDPOINT_SERVICE, VPC_RESOURCE, MSK_MULTI_VPC

例:

"VPC_ENDPOINT_SERVICE"

vpcEndpointServiceName · string | null

VPC endpoint service 名。

例:

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

vpcResourceConfigurationId · string | null

VPC リソース構成 ID。VPC_RESOURCE タイプで必須です。

例:

"rcfg-12345678901234567"

vpcResourceShareArn · string | null

VPC リソース共有 ARN。VPC_RESOURCE タイプで必須です。

例:

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

レスポンス

200

application/json

成功時のレスポンス

requestId · string<uuid>

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

result · object

Show child attributes

status · number

HTTPステータスコード。

例:

200