IP許可リストAPIのエンドポイント
このAPIへのアクセスに使われるホストはhttps://api.<env>.cloud.talend.comです。
このAPIサービスの全容がわかるAPIドキュメンテーションは、https://api.<env>.cloud.talend.com/v1/management/swagger-ui/?urls.primaryName=IP%20Allowlist%20Managementをご覧ください。
<env>には、お使いのクラウドリージョンが入ります。リージョン名がわからない場合は、Talend Cloudのアプリケーションにアクセスをご覧ください。
APIの呼び出しにはアクセストークンを使用する必要があります。アクセストークンを生成する方法、およびそのトークンを使用する方法の詳細は、パーソナルアクセストークンを生成をご覧ください。
次の表には、IP許可リストAPIエンドポイントと必要な権限が示されています
| 操作 | メソッド | リソース | 必要な権限 |
|---|---|---|---|
| IP許可リストポリシー(リスト上のIP、このポリシーが有効になっているかどうかなど)の設定の取得 | GET |
/v1/management/ip-allowlist |
[Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーの設定全体を構成します。このリクエストでは、IPを追加して(または追加せずに)IP許可リストを作成し、同時にIP許可リストポリシー有効にするかどうか定義します。 IP許可リストポリシーが有効になると、Talend Cloudにアクセスできるのは許可リストに登録されているIPだけとなります。 |
POST | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーの設定をアップデートします。このリクエストでは、既存のIP許可リストにIPを追加し、同時にIP許可リストポリシーを有効または無効にします。 IP許可リストポリシーが有効になると、Talend Cloudにアクセスできるのは許可リストに登録されているIPだけとなります。 |
PUT | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーを削除します。 | DELETE | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーを有効または無効にします。 | PATCH | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストからIPをすべて取得します。 | GET | /v1/management/ip-allowlist/ips | [Users - Management] (ユーザー - 管理) |
| IIP許可リストに新しいIPを追加します。 | POST | /v1/management/ip-allowlist/ips | [Users - Management] (ユーザー - 管理) |
| IP許可リストでIPセットをアップデートします。アップデートするIPのIDをリクエストに入力しておく必要があります。 | PUT | /v1/management/ip-allowlist/ips | [Users - Management] (ユーザー - 管理) |
| IP許可リストで、IDを使って特定のIPを取得します。 | GET | /v1/management/ip-allowlist/ips/<ip_entry_id> | [Users - Management] (ユーザー - 管理) |
| IP許可リストでIDを使ってIPを検索し、リクエストに入力した新しいアドレスでこのIPをアップデートします。 | PUT | /v1/management/ip-allowlist/ips/<ip_entry_id> | [Users - Management] (ユーザー - 管理) |
| IP許可リストから特定のIDを削除 | DELETE | /v1/management/ip-allowlist/ips/<ip_entry_id> | [Users - Management] (ユーザー - 管理) |