クラウド操作 API のリファレンス

クラウド操作 API に関する詳細情報を示します。

これらの API の完全な OpenAPI 仕様は、以下のトピックに記載されています。使用可能な API は、ご使用のクラウド・サブスクリプションによって異なる場合があります。使用可能な API を確認するには、API テスト・ツールを使用します。

注：これらの操作は IBM® Operational Decision Manager on Cloud.

REST API テスト・ツールへのアクセス

https://hostname/api/explorerでの Swagger ユーザー・インターフェースにアクセスでき、ここで、 ホスト名 はオファリング・サブスクリプションの名前です。例えば、 https://vhost123.mycloud.com/api/explorerなどです。このインターフェースには、使用可能なエンドポイントのビューとドキュメント、および各エンドポイントをテストするための「Try it out」ボタンが表示されます。

OpenAPI 仕様に直接アクセスするには、以下の REST API 呼び出しを使用できます。

GET /api/docs

この呼び出しは、ご使用のサブスクリプションで使用可能な API の OpenAPI 仕様を含む JSON オブジェクトを返します。

認証

どのエンドポイントも認証が必要です。基本認証を使用して、クラウド・サブスクリプションのユーザー名とパスワードで認証できます。例:

curl https://tenant_name.automationcloud.ibm.com/instance/services/users --user username@company_name.com:password

注意: Swaggerユーザーインターフェイスでは、REST APIメソッドの一部にイメージは警告アイコンを示しています

警告アイコンが表示される場合があります。この警告をクリックすると、ログイン資格情報を要求するウィンドウが開きます。クラウド・ポータルに認証されていれば、再認証の必要はありませんのでこの警告は無視できます。

基本認証の代わりに、サービス資格情報を使用してアプリケーションを認証することもできます。詳細については、クライアント・アプリケーションの認証を参照してください。

フィルター処理とページ編集

/users など、オブジェクトのコレクションを返す検索メソッドによるページ編集を行うことができます。デフォルトではコレクションのすべてのエレメントが返されますが、ページ・サイズとページ番号を指定してコレクションのサブセットのみを取得することができます。例:

curl https://tenant_name.automationcloud.ibm.com/instance/services/users?offset=2&size=20 --user username@company_name.com:password

API 固有のパラメーターを呼び出しに追加して、オブジェクト・コレクションをフィルタリングすることもできます。使用できるパラメーターについては、各 API の資料を参照してください。

エラー

API 要求の成功または失敗は、従来の HTTP 応答コードで示されます。エラーが発生した場合は、エラー・コード、理由、参照を示す JSON エラー・オブジェクトが HTTP 応答の本文に必ず含まれています。例:

{
  "error_number": "CWMGG0006E",
  "error_message": "CWMGG0006E: The value 'username@company_name.com' is invalid for the 'member_id' parameter.",
  "error_message_parameters": [
    "username@company_name.com",
    "member_id"
  ],
  "incident_id": "62d28e96-3059-433a-911d-f9109a7fc93a"
}