OpenAPI Explorer 、 Alibaba Cloud SDK 、およびその他の統合方法を使用して ApsaraDB for ClickHouse の API を呼び出す方法について説明します。
OpenAPI
OpenAPI Explorer は、API の検索、ドキュメント、オンラインデバッグ、SDK コードサンプル、エラー診断、呼び出し統計のためのオールインワンプラットフォームです。Alibaba Cloud のサービス全体で API を呼び出し、テストするために使用します。OpenAPI とは
バージョン
ApsaraDB for ClickHouse の Cluster Edition ごとに使用する API バージョンは異なります。お使いのエディションに一致するバージョンを選択してください。
|
バージョン番号 |
説明 |
|
2019-11-11 |
Community-compatible Edition クラスターの API を呼び出すには、このバージョンを使用します。 |
|
2023-05-22 |
Enterprise Edition クラスターの API を呼び出すには、このバージョンを使用します。 |
オンラインデバッグ
OpenAPI Explorer で ApsaraDB for ClickHouse の API をデバッグできます。呼び出しを行う前に、ApsaraDB for ClickHouse の API バージョン、エンドポイント、および統合方法を確認してください。
左側のペインには、リージョン管理、クラスター管理、コンピューティンググループ管理などの API カテゴリが一覧表示されます。API を選択してその説明を表示し、ZoneId や RegionId などのパラメーターを設定し、[呼び出しの開始] をクリックしてテストします。右側のペインには、パラメーターの説明と値の例が表示されます。
API デバッグ URL
ApsaraDB for ClickHouse は、Community-compatible Edition および Enterprise Edition で利用できます。各エディションには個別のデバッグ URL があります。
|
エディション |
API デバッグ URL |
|
Community-compatible Edition |
ApsaraDB for ClickHouse Community-compatible Edition の API デバッグ URL |
|
Enterprise Edition |
エンドポイント
レイテンシーを最小限に抑えるには、リソースと同じリージョンにあるエンドポイントを選択してください。たとえば、中国 (張家口) リージョンにある ApsaraDB for ClickHouse クラスターの場合、パブリックエンドポイントは clickhouse.cn-zhangjiakou.aliyuncs.com で、VPC エンドポイントは clickhouse-vpc.cn-zhangjiakou.aliyuncs.com です。
-
パブリックエンドポイントはグローバルにアクセス可能です。
-
VPC エンドポイントは分離された仮想ネットワーク上で動作し、以下の利点があります。
-
より高いセキュリティ: VPC 内からのみアクセス可能です。
-
より低いレイテンシー:内部ネットワークであり、パブリックネットワークの変動に影響されません。
-
より低いコスト:内部トラフィックによりデータ転送コストが削減されます。
-
サポートされているすべてのリージョンとエンドポイントは、「サービスエンドポイント」に記載されています。
サポートされているユーザーアイデンティティ
OpenAPI Explorer は、デフォルトでデバッグのためにサインインしているアカウントを使用します。Alibaba Cloud アカウントは完全な API 権限を持っているため、API アクセスや日常の O&M には、必要最小限の権限を持つ RAM ユーザーを使用してください。RAM ユーザーに ApsaraDB for ClickHouse を管理する権限を付与してください。「RAM 認可」をご参照ください。
|
アイデンティティ |
サポート状況 |
|
はい |
|
|
RAM ユーザー (推奨) |
はい |
|
RAM ロール (推奨) |
はい |
統合方法
ApsaraDB for ClickHouse は、Alibaba Cloud SDK 、 Terraform 、 Resource Orchestration Service (ROS) 、およびカスタムカプセル化といった複数の統合方法をサポートしています。
SDK は統合を簡素化するため、OpenAPI を呼び出すための推奨される方法です。
|
統合方法 |
サポート状況 |
|
Alibaba Cloud SDK |
はい |
|
Alibaba Cloud CLI |
サポート対象外 |
|
Terraform |
サポート対象外 |
|
Resource Orchestration Service (ROS) |
一部サポート |
|
カスタムカプセル化 |
はい |
Alibaba Cloud SDK
-
Alibaba Cloud SDK は、Java 、 C# 、 Go 、 Python 、 Node.js 、 TypeScript 、 PHP 、および C++ をサポートしています。SDK が認証と署名を処理するため、API を直接呼び出すことができます。詳細については、「Alibaba Cloud SDK」をご参照ください。
-
Alibaba Cloud SDK を使用して ApsaraDB for ClickHouse の API を呼び出すことができます。サポートされている言語とインストール手順は、「ApsaraDB for ClickHouse SDK 概要」に記載されています。
Alibaba Cloud CLI
-
Alibaba Cloud CLI を使用すると、
aliyunコマンドを使用してシェルからクラウドリソースを管理できます。詳細については、「Alibaba Cloud CLI とは」をご参照ください。 -
Alibaba Cloud CLI を使用して ApsaraDB for ClickHouse の API を呼び出すことはできません。
Terraform
-
Terraform は、テンプレートを通じてクラウドインフラストラクチャをプロビジョニングおよび管理するためのオープンソースツールです。詳細については、「Alibaba Cloud Terraform とは」をご参照ください。
-
Terraform を使用して ApsaraDB for ClickHouse の API をオーケストレーションすることはできません。
Resource Orchestration Service (ROS)
-
ROS は、テンプレートを通じてクラウドリソースのプロビジョニングを自動化します。Elastic Compute Service (ECS) インスタンスや ApsaraDB for RDS (RDS) インスタンスなどのリソースとその依存関係を定義すると、ROS が自動的にそれらを作成し、設定します。詳細については、「Resource Orchestration Service とは」をご参照ください。
-
ROS を使用した ApsaraDB for ClickHouse の API の呼び出しは一部サポートされています。サポートされているリソースタイプとデータソースは、「ROS リソースリスト」に記載されています。
カスタムカプセル化
ネイティブの HTTP 呼び出しについては、V3 署名アルゴリズムを実装し、手動でリクエストを構築してください。詳細については、「V3 のリクエストボディと署名メカニズム」をご参照ください。
使用上の注意
API 呼び出しでエラーが返された場合は、エラーコードセンターを参照してリクエストパラメーターを確認してください。
レスポンスから得られる RequestID または SDK のエラーメッセージを使用して、Alibaba Cloud OpenAPI 診断プラットフォームで問題を診断してください。