IBM Cloud Docs
管理 REST API の使用

管理 REST API の使用

Event Streams では、トピックを作成、削除、リストおよび更新するために使用できる管理 RESTful API が提供されています。

サービス・インスタンスのサービス資格情報オブジェクトまたはサービス・キーから、 API に接続するために必要な URL と資格情報の詳細を取得する必要があります。 これらのオブジェクトの作成について詳しくは、Event Streams への接続を参照してください。

API のエンドポイントの URL は、kafka_admin_urlプロパティーで指定されます。

資格情報は認証方式によって異なり、3 つのタイプの資格情報がサポートされます。

基本認証を使用した認証

オブジェクトの user プロパティーと api_key プロパティーをユーザー名とパスワードとして使用します。 これらの値を、Basic <base64 encoding of username and password joined by a single colon (:)>の形式で HTTP 要求のAuthorizationヘッダーに入れます。

ベアラー・トークンを使用した認証

IBM Cloud CLI を使用してトークンを取得するには、まず IBM Cloud にログインしてから、以下のコマンドを実行します。

ibmcloud iam oauth-tokens

このトークンを、Bearer <token>の形式で HTTP 要求の許可ヘッダーに入れます。 API キーと JWT トークンの両方がサポートされています。

api_key を使用した認証

キーをX-Auth-Token HTTP ヘッダーの値として直接配置します。

次のステップ

例を含む API の説明については、 Event Streams admin-restを参照してください。

API の完全な仕様は、 Event Streams Admin REST API YAML ファイルからダウンロードできます。 swagger ファイルを表示するには、Swagger ツール ( Swagger エディターなど) を使用します。