API 標準および多言語対応の SDK
本製品 (CS/2015-12-15) の API は、ROA 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID:147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
API 一覧表
|
API |
タイトル |
説明 |
| OpenAckService | コンテナサービス for Kubernetes をアクティブ化します | Container Service for Kubernetes (ACK) を初回の時間に使用する際、OpenAckService 操作を呼び出してサービスをアクティブ化する必要があります。 |
| DescribeRegions | リージョンを照会します | リージョンのリストを照会します。 |
クラスター
|
API |
タイトル |
説明 |
| CreateCluster | クラスターの作成 | OpenAPIを使用してACKクラスターを作成します。ACKマネージドクラスター、ACK Serverlessクラスター、ACKエッジクラスター、登録済みクラスターを含みます。クラスター作成時には、クラスター情報、クラスターコンポーネント、およびACK関連のクラウドリソースを設定します。 |
| DeleteCluster | クラスターを削除します | クラスターが不要になった場合、クラスターを削除し、関連リソースを削除するか保持するかを選択します。クラスターを削除する前に、ワークロード(Deployments、StatefulSets、Jobs、CronJobs)を手動でクリーンアップしてください。そうしないと、クラスターの削除が失敗する場合があります。 |
| ModifyCluster | クラスター構成の変更 | Alibaba Cloud Container サービス for Kubernetes (ACK) クラスターの構成を変更します。 |
| UpgradeCluster | クラスターをスペックアップします | 期限切れのクラスターバージョンによる潜在的なセキュリティおよび安定性のリスクを回避し、最新のクラスターバージョンの新しい特徴を使用するために、ACK クラスターバージョンのリリーススケジュールに従ってクラスターをスペックアップしてください。UpgradeCluster 操作を呼び出して、クラスターを手動でスペックアップできます。 |
| DescribeClustersV1 | クラスターリストの照会 | 現在のアカウントで、クラスタータイプやクラスタースペックなどの指定された条件に一致する ACK クラスターのリストを照会します。 |
| DescribeClustersForRegion | 指定されたリージョンのクラスターの照会 | 指定されたリージョン内のすべてのクラスターを照会します。 |
| DescribeClusterDetail | 指定されたクラスターの情報を照会します | クラスター ID を指定して、クラスターの詳細を照会します。 |
| DescribeClusterResources | 指定クラスターの関連リソースのクエリ | Container Service for Kubernetes(ACK)を使用する場合、他の関連するAlibaba Cloudサービスのリソースも使用されます。DescribeClusterResources操作を呼び出して、VPCやSLBなどの指定クラスターの関連リソースをクエリできます。ノードプールまたはノードリソースをクエリするには、DescribeClusterNodePoolsまたはDescribeClusterNodes操作を呼び出します。 |
| DescribeKubernetesVersionMetadata | Kubernetes バージョンの詳細情報を照会します | Kubernetes バージョンの詳細情報を照会します。バージョン情報、リリース日と有効期限、互換オペレーティングシステム、コンテナランタイムなどが含まれます。 |
| DescribeUserClusterNamespaces | クラスター内で RAM ユーザーまたはロールに表示される名前空間をクエリします | ACK クラスターでは、Kubernetes の名前空間を使用して、クラスターユーザーの権限とリソースを論理的に分離された状態で管理できます。指定された名前空間に対する RBAC 権限のみを付与されたユーザーは、クラスター内の他の名前空間のリソースにアクセスできません。DescribeUserClusterNamespaces 操作を呼び出して、指定された ACK クラスターで現在の Resource Access Management (RAM) ユーザーまたはロールに RBAC アクセス権限が付与されている名前空間をクエリできます。 |
| DescribeClusterLogs | クラスターログをクエリします | クラスターの問題が発生した際のルート原因分析とトレーシングのために、クラスターのログデータを取得します。 |
| DescribeUserQuota | クラスタークォータの照会 | ACK クラスター、ノードプール、およびノードのクォータを照会します。クォータを引き上げるには、クォータセンターにアクセスしてリクエストを送信してください。 |
| MigrateCluster | Basic クラスターをプロ版に移行します | ACK プロ版クラスターは ACK Basic クラスターの進化版であり、マネージドコントロールプレーンや高可用性コントロールプレーンなど、マネージドクラスターのすべての利点を継承しています。ACK プロ版クラスターは、クラスターの信頼性、セキュリティ、およびスケジューリング機能をさらに強化し、補償基準付きの SLA をサポートします。ACK プロ版クラスターは、本番環境で大規模なワークロードを実行し、安定性とセキュリティに対する高い要件を持つエンタープライズのお客様に適しています。MigrateCluster オペレーションを呼び出して、ACK Basic クラスターを ACK プロ版クラスターに移行できます。 |
| DescribeClusterUserKubeconfig | クラスター kubeConfig を照会します | KubeConfig は、クライアントで ACK クラスターのアクセス認証情報を構成するために使用されます。ターゲットクラスターにアクセスするための ID および認証データが含まれています。kubectl を使用してクラスター管理を行う場合、まず KubeConfig を使用してクラスターに接続する必要があります。DescribeClusterUserKubeconfig 操作を呼び出して、指定されたクラスターの KubeConfig をクエリできます。 |
| DescribeSubaccountK8sClusterUserConfig | Alibaba Cloud アカウントを使用して指定された RAM ユーザーまたはロールのクラスター kubeConfig を取得します | クラスター権限管理の管理者として、Alibaba Cloud アカウントを使用して、アカウント内の指定された Resource Access Management (RAM) ユーザーまたは RAM ロールの ID 情報を含む KubeConfig 資格情報を発行できます。これらの資格情報は ACK クラスターへの接続に使用されます。DescribeSubaccountK8sClusterUserConfig 操作を呼び出して、アカウント内の任意の RAM ユーザーまたはロールの KubeConfig を発行または取得できます。 |
| ListUserKubeConfigStates | 指定されたユーザーのすべてのクラスターの kubeConfig ステータスリストを照会します | 現在のユーザーのすべてのクラスターの KubeConfig ステータスリストを照会します。現在のユーザーの各クラスターの KubeConfig 発行ステータスを確認する場合、この操作を呼び出してすべてのクラスターの KubeConfig ステータスリストを取得できます。 |
| ListClusterKubeconfigStates | 指定されたクラスターの発行済み kubeConfig のリストを照会します | 指定されたクラスターでユーザーに発行された KubeConfig のリストとステータスを照会します。この操作を呼び出して、現在のクラスターのアクセスのコントロールステータスを確認できます。 |
| UpdateK8sClusterUserConfigExpire | ユーザー定義構成の有効期限を更新します | ACK クラスターが発行する KubeConfig のデフォルトの有効期限は 3 年です。Alibaba Cloud アカウントを使用して、UpdateK8sClusterUserConfigExpire 操作を呼び出すことで、ACK クラスター内の Resource Access Management (RAM) ユーザーまたはロールに発行される KubeConfig の有効期限 (1~876,000 時間) を指定し、構成をカスタマイズできます。 |
| RevokeK8sClusterKubeConfig | 現在のユーザーの kubeConfig を取り消します | 現在ログインしている Alibaba Cloud アカウントまたは Resource Access Management (RAM) ユーザーのコンテナサービス for Kubernetes (ACK) クラスターの KubeConfig 認証情報を取り消します。取り消し後、クラスターは新しい KubeConfig を生成し、元の KubeConfig は無効になります。 |
| CleanClusterUserPermissions | 指定されたクラスター内の指定されたユーザーのkubeConfig認証情報とRBACパーミッションをクリーンアップする | 指定されたクラスター内の指定されたユーザーに発行されたKubeConfig認証情報とRBACパーミッションをクリーンアップします。セキュリティリスクのあるKubeConfig認証情報の認可を取り消すために、このオペレーションを呼び出すことができます。 |
| CleanUserPermissions | 指定されたユーザーのすべてのクラスターにわたる発行済み kubeConfig 資格情報と RBAC 権限をクリーンアップします | 指定されたユーザーの KubeConfig 資格情報をクリーンアップし、RBAC 権限を取り消します。組織を離れたユーザーやアカウントが凍結されたユーザーなど、リスクのあるユーザーの KubeConfig 資格情報をクリーンアップし、権限付与を取り消す場合は、CleanUserPermissions を呼び出して、指定されたユーザーに発行された KubeConfig 資格情報と RBAC 権限をクリーンアップします。 |
ノードプール
|
API |
タイトル |
説明 |
| CreateClusterNodePool | ノードプールを作成します | ノードプールは、同じ属性を共有するノードの論理的なコレクションであり、ノードのアップグレードや弾力的スケーリングなどの統一された管理と運用が可能です。さらに、OS の CVE 脆弱性の自動パッチ適用、障害ノードの自動復旧、kubelet および containerd バージョンの自動アップグレードなど、ノードプールの自動化された O&M 機能を活用して、O&M コストを削減できます。CreateClusterNodePool を呼び出して、クラスターのノードプールを作成できます。 |
| DeleteClusterNodepool | ノードプールを削除します | 使用されなくなったノードプールを削除します。ノードプールを削除すると、ノード上のすべての Pod が削除され、デスケジューリングがトリガーされる場合があります。デスケジューリングを実行できない場合、サービスに影響が出る可能性があります。クラスターにデスケジューリングのための十分なリソースがあることを確認してください。 |
| DescribeClusterNodePoolDetail | ノードプールの構成を照会します | ノードプール ID を指定して、クラスター内の指定されたノードプールの構成を照会します。 |
| DescribeClusterNodePools | ノードプールの照会 | クラスター内のすべてのノードプールを照会します。 |
| DescribeNodePoolVuls | ノードプール脆弱性のクエリ | DescribeNodePoolVuls操作を呼び出して、ノードプールIDに基づいてノードプールのセキュリティ脆弱性の詳細をクエリします。詳細には、脆弱性名と重大度レベルが含まれます。クラスターのセキュリティを向上させるために、ノードプールのセキュリティ脆弱性を定期的にスキャンしてください。 |
| ModifyClusterNodePool | ノードプールの構成を変更します | ノードプール ID に基づいてノードプールの構成を更新します。 |
| ScaleClusterNodePool | ノードプールのスケールアウト | ノードプールにノードを追加してスケールアウトし、ワークロードをサポートするのに十分なノード数を確保します。 |
| AttachInstancesToNodePool | 既存のノードをノードプールに追加します | ACK クラスターのノードプールに既存の ECS インスタンスを追加します。この操作を呼び出して、既存の ECS インスタンスをワーカーノードとして ACK クラスターに追加したり、削除されたノードインスタンスをノードプールに再追加したりできます。 |
| RemoveNodePoolNodes | ノードプールからノードを削除します | クラスター内のノードプールからノードを削除し、期待されるノード数を調整します。ノードを削除する際、関連する ECS インスタンスをリリースするかどうか、およびノードをドレインするかどうかを指定できます。ノードの削除には Pod の移行が伴うため、サービスに影響を与える可能性があります。オフピーク時間帯にこの操作を実行し、事前にデータをバックアップしてください。 |
| UpgradeClusterNodepool | ノードプールをアップグレードします | 指定されたクラスターノードプールの kubelet バージョン(コントロールプレーンバージョンと一致する必要があります)、オペレーティングシステムバージョン、またはコンテナランタイムバージョンをアップグレードします。 |
| RepairClusterNodePool | ノードプールノードを修復します | クラスターノードプール内のノードを修復します。 |
| FixNodePoolVuls | ノードプールの脆弱性を修正します | Alibaba Cloud セキュリティ製品は、ECS ノードのセキュリティ脆弱性を定期的にスキャンし、対応する修復の提案と方法を提供します。一部の CVE 修正にはノードの再起動が必要になる場合があります。ドレイン操作に十分なノードがクラスターにあることを確認してください。FixNodePoolVuls 操作を呼び出して、指定されたクラスターノードプールのノードセキュリティ脆弱性を修正し、クラスターノードのセキュリティを向上させることができます。 |
| ModifyNodePoolNodeConfig | ノードプールのノード構成を変更します。 | クラスターノードプールのノード構成(kubelet 構成やローリングアップデート構成など)を変更します。ノード構成の変更はバッチで適用され、kubelet が再起動されるため、ノードの操作やワークロードの実行に影響を与える可能性があります。この操作はオフピーク時間帯に実行してください。 |
| SyncClusterNodePool | ノードプールを同期します | ノードプールのメタデータやノードプール内のノードに関する情報を含む、クラスターノードプールを同期します。 |
| DescribeClusterAttachScripts | クラスターノードプールに既存のノードを追加するためのスクリプトを照会します | クラスターノードプールに既存のノードを追加するためのスクリプトを照会します。既存の ECS インスタンスを ACK クラスターにワーカーノードとして追加する場合、またはノードプールから削除されたノードインスタンスを再度追加する場合、ACK では既存のノードをノードプールに手動で追加できます。DescribeClusterAttachScripts 操作を呼び出して、既存のノードを追加するためのスクリプトを取得します。 |
| CreateAutoscalingConfig | 弾力的スケーリング構成を作成します | 弾力的スケーリング構成を作成します。この構成により、設定されたスケーリングルールに基づいてコンピューティングリソースを自動的に増減し、クラスターのワークロード要件を満たすことができます。作成プロシージャでは、スケーリングメトリクスとしきい値、スケールアウトの注文、クールダウン期間などを指定できます。 |
ノード
|
API |
タイトル |
説明 |
| DescribeClusterNodes | クラスターノードの照会 | クラスター内で指定された条件を満たすノードのリストを照会します。 |
| DeleteClusterNodes | クラスターノードを削除します | クラスターノードの稼働が不要になった場合、DeleteClusterNodes 操作を呼び出してクラスターからノードを削除できます。ノードを削除する際、ECS インスタンスを同時にリリースするかどうか、およびノードを自動的にドレインするかどうかを選択できます。 |
| AttachInstances | 既存の ECS インスタンスをクラスターに追加します | 既存の Elastic Compute Service (ECS) インスタンスを Container サービス for Kubernetes (ACK) クラスターに追加します。AttachInstances 操作を呼び出して、購入済みの ECS インスタンスをワーカーノードとして ACK クラスターに追加したり、ノードプールから削除されたノードインスタンスを再追加したりできます。 |
コンポーネント
|
API |
タイトル |
説明 |
| InstallClusterAddons | クラスターコンポーネントをインストールします | Kubernetes の機能を強化するために、ACK クラスターはマネージドコアコンポーネント、アプリケーションコンポーネント、ロギングおよびモニタリングコンポーネント、ネットワークコンポーネント、ストレージコンポーネント、セキュリティコンポーネントなど、さまざまなコンポーネントをサポートしています。InstallClusterAddons 操作を呼び出して、コンポーネント名とバージョンを指定することでコンポーネントをインストールできます。 |
| UnInstallClusterAddons | クラスターコンポーネントをアンインストールします | 不要になったコンポーネントをクラスターからアンインストールします。関連する Alibaba Cloud リソースを削除するオプションもあります。 |
| ListAddons | 使用可能なコンポーネントの照会 | リージョン、クラスタータイプ、クラスターサブタイプ(プロファイル)、クラスターバージョンなどの指定されたパラメーターに基づいて、使用可能なコンポーネントの一覧を照会します。コンポーネントがマネージドかどうか、サポートされているカスタムパラメーターのスキーマ、互換性のあるオペレーティングシステムアーキテクチャなど、コンポーネントの詳細情報を取得することもできます。 |
| ListClusterAddonInstances | クラスターのインストール済みコンポーネントインスタンスをリストします | 指定されたクラスターにインストールされているコンポーネントインスタンスをリストし、コンポーネントのバージョンやステータスなど、コンポーネントインスタンスに関する情報を照会します。 |
| GetClusterAddonInstance | クラスター内のコンポーネントインスタンス情報の照会 | クラスター内の指定されたコンポーネントインスタンスの詳細(コンポーネントインスタンスのバージョン、パラメータ設定、ログ機能のステータスなど)を照会します。 |
| DescribeAddon | コンポーネントの情報を照会します | DescribeAddon 操作を呼び出して、リージョン、クラスタータイプ、クラスターサブタイプ(プロファイル)、クラスターバージョン、コンポーネント名などのパラメーターに基づいて、指定されたコンポーネントの情報をクエリできます。返される情報には、コンポーネントがマネージドかどうか、コンポーネントカテゴリ、サポートされるカスタムパラメータースキーマ、互換 OS アーキテクチャ、およびコンポーネントバージョンに必要な最小クラスターバージョンが含まれます。 |
| ModifyClusterAddon | クラスターコンポーネントインスタンスの構成を変更します | インストール済みのクラスターコンポーネントインスタンスの構成を変更します。構成の変更はサービスに影響を与える可能性があります。オフピーク時間帯にこの操作を実行する前に影響を評価し、関連データを事前にバックアップしてください。 |
| UpgradeClusterAddons | クラスターコンポーネントインスタンスをスペックアップします | クラスターコンポーネントインスタンスのバージョンをスペックアップし、新しいバージョンの特徴の最適化を活用できるようにします。 |
| ListClusterAddonInstanceResources | クラスターコンポーネントインスタンスのリソースを照会します | インストール済みのクラスターコンポーネントインスタンスに含まれるリソースのリストを照会します。Kubernetes クラスターリソースおよび Helm リリースインスタンスを含みます。 |
権限
|
API |
タイトル |
説明 |
| DescribeUserPermission | RAM ユーザーまたはロールのクラスター認可情報を照会します | ACK クラスターでは、異なる Resource Access Management (RAM) ユーザーまたはロールに異なるアクセス権限を作成および割り当てることで、安全なアクセスの制御とリソース分離を確保できます。DescribeUserPermission 操作を呼び出して、RAM ユーザーまたはロールに付与されたクラスター権限の詳細(アクセス可能なリソース、権限の範囲、プリセットロールタイプ、権限ソースなど)をクエリできます。 |
| GrantPermissions | RAM ユーザーまたはロールのすべての RBAC 権限を更新します | デフォルトでは、クラスター作成者ではなく、すべてのクラスターディメンションにわたるアクセス権限が付与されていない Resource Access Management (RAM) ユーザーまたはロールは、クラスター内の RBAC 権限を持ちません。GrantPermissions 操作を呼び出して、RAM ユーザーまたはロールの RBAC アクセス権限(アクセス可能なリソース、権限の範囲、プリセットロールタイプなど)を更新し、クラスター管理のセキュリティとアクセスの制御をより適切に管理できます。 |
| UpdateUserPermissions | 指定された RAM ユーザーまたはロールの RBAC 権限を更新します | ACK クラスターでは、クラスター作成者以外の RAM ユーザーおよび RAM ロールにはデフォルトで RBAC 権限がありません。UpdateUserPermissions 操作を呼び出して、RAM ユーザーまたはロールの RBAC アクセス権限(アクセス可能なリソース、権限の範囲、プリセットロールタイプなど)を更新し、クラスター管理とアクセスの制御のセキュリティを向上させることができます。 |
| CheckServiceRole | サービスロールの権限付与ステータスを確認します | 現在のサービスアカウントに指定されたサービスロールの権限が付与されているかどうかを確認します。Container Service for Kubernetes (ACK) は、対応するロールの権限が付与された後にのみ、サービスロールに関連付けられた他のクラウドサービス (ECS、OSS、NAS、SLB など) を呼び出すことができます。 |
セキュリティ
|
API |
タイトル |
説明 |
| ScanClusterVuls | クラスターのセキュリティ脆弱性をスキャンします | ACK クラスターの潜在的なセキュリティ脆弱性をスキャンします。コンテナワークロードの脆弱性、サードパーティソフトウェアの脆弱性、CVE 脆弱性、WebCMS 脆弱性、Windows オペレーティングシステムの脆弱性が含まれます。クラスターのセキュリティを向上させるために、定期的にクラスターのセキュリティ脆弱性をスキャンしてください。 |
| DescribeClusterVuls | クラスターのセキュリティ脆弱性情報を照会します | クラスター ID を指定して、クラスターのセキュリティ脆弱性の詳細(脆弱性名、タイプ、重大度レベルなど)を照会します。クラスターのセキュリティを向上させるために、定期的にクラスターのセキュリティ脆弱性をスキャンしてください。 |
| UpdateResourcesDeleteProtection | 指定されたリソースの削除保護ステータスの更新 | 指定されたリソースの削除保護ステータスを更新します。現在サポートされているリソースタイプには、名前空間とサービスが含まれます。 このオペレーションを呼び出して、重要なビジネスや機密データに関連する名前空間またはサービスの削除保護を有効にし、誤った削除による保守コストを回避できます。 |
| DescribeResourcesDeleteProtection | 指定されたリソースの削除保護が有効かどうかの照会 | クラスター内の指定されたリソースに対して削除保護が有効になっているかどうかを照会します。削除保護をサポートするリソースには、名前空間とサービスが含まれます。 |
| DeployPolicyInstance | ポリシーインスタンスをデプロイします | 指定されたクラスターの指定された名前空間にポリシーインスタンスをデプロイします。ACK クラスターでセキュリティポリシータイプを選択し、ポリシーインスタンスのガバナンス操作(アラート機能またはブロック)と名前空間の範囲を設定して、ポリシーインスタンスを作成およびデプロイできます。 |
| ModifyPolicyInstance | ポリシールールインスタンスを更新します | 指定されたクラスター内のポリシールールインスタンスを更新します。ガバナンス操作(アラートまたはブロック)およびポリシーインスタンスが適用される名前空間の範囲を変更できます。 |
| DeletePolicyInstance | ポリシールールインスタンスを削除します | 指定されたクラスターからポリシールールインスタンスを削除します。 |
| DescribePolicies | ポリシーガバナンスルールライブラリのリストを照会します | ACK クラスターコンテナセキュリティポリシーは、本番環境でのコンテナの安全な運用を確保するために、Compliance、Infra、K8s-general、PSP カテゴリを含む包括的な組み込みルールライブラリを提供します。DescribePolicies 操作を呼び出して、ポリシーガバナンスルールライブラリのリストをクエリできます。 |
| DescribePolicyDetails | 指定されたポリシーガバナンスルールの詳細を照会します | ACK クラスターコンテナセキュリティポリシーは、Compliance、Infra、K8s-general、PSP を含む豊富な組み込みルールライブラリのセットを提供し、本番環境でのコンテナの安全な運用を確保します。DescribePolicyDetails 操作を呼び出して、指定されたポリシーガバナンスルールの詳細(ルールテンプレートの説明、ガバナンス操作、ガバナンスの重大度レベルなど)をクエリできます。 |
| DescribePolicyGovernanceInCluster | クラスターのポリシーガバナンスの詳細を照会 | ACKクラスターのコンテナセキュリティポリシーは、Compliance、Infra、K8s-general、PSPなどの豊富な組み込みルールライブラリを提供し、本番環境でのコンテナの安全な運用を確保します。DescribePolicyGovernanceInCluster操作を呼び出して、指定したクラスターの詳細なポリシーガバナンス情報(異なる重大度レベルで有効になっているポリシーの数、ポリシーガバナンス監査ログ、インターセプトおよびアラートの詳細など)を照会できます。 |
| DescribePolicyInstances | ポリシーインスタンスの一覧取得 | ACKクラスターでセキュリティポリシータイプを選択し、関連する適用アクションとスコープを設定して、ポリシーインスタンスを作成およびデプロイできます。DescribePolicyInstances操作を呼び出して、ポリシーの説明やガバナンスレベルなど、クラスター内の指定されたポリシーインスタンスの詳細を取得できます。 |
| DescribePolicyInstancesStatus | ポリシーインスタンスのデプロイ詳細の表示 | クラスター内の異なるポリシータイプにおけるポリシーインスタンスのデプロイステータスを照会します。各ポリシールールの有効なインスタンス数や、異なるガバナンスレベルにおける有効なポリシータイプの数が含まれます。 |
クラスターの検査と診断
|
API |
タイトル |
説明 |
| RunClusterCheck | クラスターチェックの開始 | コンテナ向けインテリジェント運用プラットフォームは、クラスターアップグレードチェック、クラスター移行チェック、コンポーネントインストールチェック、コンポーネントアップグレードチェック、ノードプールチェックなど、幅広いKubernetesクラスターチェック機能を提供します。アップグレード、移行、またはインストール操作を実行する前に、プラットフォームは自動的にチェックをトリガーします。チェックに合格した後にのみ、変更操作を実行できます。RunClusterCheckオペレーションを手動で呼び出してクラスターチェックを実行することもできます。セキュリティリスクを防止するために、クラスターを定期的にチェックおよびメンテナンスしてください。 |
| ListClusterChecks | すべてのクラスターチェックをリストします | コンテナ向けインテリジェント O&M プラットフォームは、クラスタースペックアップチェック、クラスター移行チェック、コンポーネントインストールチェック、コンポーネントスペックアップチェック、ノードプールチェックなど、包括的な Kubernetes クラスターチェック機能を提供します。ListClusterChecks 操作を呼び出して、クラスター ID によりクラスターチェックのリストおよびチェックタイプ、ステータス、作成時間、完了時間などの関連情報をクエリできます。 |
| GetClusterCheck | 指定されたクラスターチェックの情報を照会します | コンテナ向けインテリジェント O&M プラットフォームは、クラスタースペックアップチェック、クラスター移行チェック、コンポーネントインストールチェック、コンポーネントスペックアップチェック、ノードプールチェックなど、包括的な Kubernetes クラスターチェック機能を提供します。GetClusterCheck 操作を呼び出して、クラスター ID とチェックタスク ID に基づいて、チェックステータス、具体的なチェック項目、チェックの作成時間と完了時間など、指定されたチェックタスクの情報をクエリできます。 |
| CreateClusterInspectConfig | クラスター検査構成を作成します | クラスター検査構成を作成します。 |
| UpdateClusterInspectConfig | クラスター検査構成の更新 | クラスター検査構成を更新します。 |
| GetClusterInspectConfig | クラスター検査構成を取得します | クラスターの検査構成を取得します。 |
| RunClusterInspect | クラスター検査レポートを作成します | クラスター検査を開始し、検査レポートを作成します。 |
| ListClusterInspectReports | クラスター検査レポートリストを取得します | クラスター検査レポートのリストを取得します。 |
| GetClusterInspectReportDetail | クラスター検査レポートの詳細を取得します | クラスター検査レポートの詳細を取得します。 |
| DeleteClusterInspectConfig | クラスター検査構成を削除します | クラスター検査構成を削除します。 |
| CreateClusterDiagnosis | クラスター診断の開始 | クラスター診断を開始します。 |
| GetClusterDiagnosisResult | クラスター診断結果の照会 | クラスターの診断結果を取得します。 |
| GetClusterDiagnosisCheckItems | クラスターの診断確認項目を照会します | クラスターの診断確認項目を取得します。 |
オーケストレーションテンプレート
|
API |
タイトル |
説明 |
| CreateTemplate | オーケストレーションテンプレートの作成 | オーケストレーションテンプレートは、Kubernetesクラスターリソースのセットを宣言的に定義および記述し、アプリケーションの実行方法や構成方法を指定します。これらのテンプレートを使用して、Pod、Service、Deployment、ConfigMap、PersistentVolumeなどのリソースのデプロイとクラスター管理を自動化できます。CreateTemplateオペレーションを呼び出して、オーケストレーションテンプレートを作成できます。 |
| DescribeTemplateAttribute | 指定されたオーケストレーションテンプレートの詳細を照会します | オーケストレーションテンプレートは、Kubernetes クラスターリソースのセットを宣言的に定義および記述し、アプリケーションの実行方法や設定方法を指定します。DescribeTemplateAttribute 操作を呼び出して、指定されたオーケストレーションテンプレートの詳細(アクセス権限、YAML コンテンツ、ラベルなど)をクエリできます。 |
| DescribeTemplates | すべてのオーケストレーションテンプレートを照会します | オーケストレーションテンプレートは、Kubernetes クラスターリソースのセットを宣言的に定義および記述し、アプリケーションの実行方法や設定方法を指定します。DescribeTemplates 操作を呼び出して、作成済みのオーケストレーションテンプレートのリストを取得し、アクセス権限、YAML コンテンツ、タグなどのテンプレートの詳細情報をクエリできます。 |
| UpdateTemplate | オーケストレーションテンプレートを更新します | オーケストレーションテンプレートは、Kubernetes クラスターリソースのセットを宣言的に定義および記述し、アプリケーションの実行方法や構成方法を指定します。UpdateTemplate 操作を呼び出して、オーケストレーションテンプレートの構成を更新します。 |
| DeleteTemplate | オーケストレーションテンプレートを削除します | 不要になったオーケストレーションテンプレートを削除します。 |
トリガー
|
API |
タイトル |
説明 |
| CreateTrigger | トリガーを作成します | クラスターアプリケーションのトリガーを設定します。指定された条件が満たされると、トリガーは Pod を再デプロイします。 |
| DeleteTrigger | トリガーの削除 | 不要になったアプリケーショントリガーを削除します。 |
| DescribeTrigger | トリガーを照会します | 指定された条件に一致するトリガーを照会します。 |
タグ
|
API |
タイトル |
説明 |
| ListTagResources | クラスターのタグリストの照会 | クラスターにタグのキーと値のペアを追加することで、クラスターの開発者や運用エンジニアがクラスターをより柔軟に分類・管理し、監視、コスト分析、マルチテナントデータ分離などの要件をより適切にサポートできます。ListTagResources操作を呼び出して、リソースタグのリストを取得し、キーと値のペアや関連するクラスターなどの詳細なタグ情報を照会できます。 |
| TagResources | クラスターにタグを付与する | クラスターにタグのキーと値のペアを追加し、クラスター開発者や運用保守エンジニアがクラスターをより柔軟に分類・管理し、モニタリング、コスト分析、テナント分離の要件をよりよくサポートできるようにします。TagResources オペレーションを呼び出してクラスターにタグを付与できます。 |
| UntagResources | クラスタータグを削除します | クラスターのタグキーと値のペアが不要になった場合に、リソースタグを削除します。UntagResources 操作を呼び出してリソースタグを削除できます。 |
| ModifyClusterTags | すべてのクラスタータグをフルアップデートします | クラスターにタグキーと値のペアを追加することで、クラスター開発者や運用エンジニアがクラスターをより柔軟に分類・管理し、モニタリング、コスト分析、テナント分離などの要件をより適切にサポートできます。ModifyClusterTags 操作を呼び出してクラスタータグを変更できます。 |
アラート
|
API |
タイトル |
説明 |
| StartAlert | アラートルールを開始します | 指定されたアラートルールを開始します。 |
| UpdateContactGroupForAlert | アラートメトリクス連絡先グループの更新 | ACK クラスターに設定されたアラートルールセットの連絡先グループを更新します。 |
| StopAlert | アラートルールを停止します | ACK アラートセンターのアラートルールを停止します。アラートルールグループ全体または単一のアラートルールを停止できます。 |
| DeleteAlertContact | アラート連絡先を削除します | ACK からアラート連絡先を削除します。 |
| DeleteAlertContactGroup | アラート連絡先グループを削除します | ACK アラート連絡先グループを削除します。 |
ログ
|
API |
タイトル |
説明 |
| UpdateControlPlaneLog | ACK マネージドクラスターのコントロールプレーンコンポーネントログ構成を更新します | ACK マネージドクラスターは、コントロールプレーンコンポーネントのログを収集し、Simple Log Service (SLS) Log Project に配信する機能をサポートしています。コントロールプレーンコンポーネントには、Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager、およびその他のコアコンポーネントが含まれます。UpdateControlPlaneLog 操作を呼び出して、ログ保持期間やログを収集するコンポーネントなど、コントロールプレーンコンポーネントのログ構成を変更できます。 |
| CheckControlPlaneLogEnable | ACKマネージドクラスターのコントロールプレーンコンポーネントのログ設定の照会 | ACKマネージドクラスターのコントロールプレーンコンポーネントのログ設定を照会します。コントロールプレーンコンポーネントには、Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Managerが含まれます。CheckControlPlaneLogEnableオペレーションを呼び出して、ログの保持期間やログを収集するコンポーネントなど、コントロールプレーンコンポーネントの現在のログ設定を照会できます。 |
| GetClusterAuditProject | クラスターAPIサーバー監査ログ用SLSプロジェクトの照会 | クラスターのAPIサーバー監査機能が有効かどうかを照会し、APIサーバー監査ログを格納するSimple Log Service(SLS)プロジェクトを取得します。 |
| UpdateClusterAuditLogConfig | クラスター監査ログ構成を更新します | Kubernetes API リクエストとその結果を Record してクラスターの操作履歴をトレースしたり、クラスターの問題をトラブルシューティングしたりする必要がある場合、UpdateClusterAuditLogConfig 操作を呼び出して、指定された ACK クラスターの監査ログ特徴を有効または無効にし、監査ログ構成を更新できます。 |
イベント
|
API |
タイトル |
説明 |
| DescribeEventsForRegion | 指定されたリージョンのイベントを照会します | 指定されたリージョン内のすべてのイベントを照会します。 |
| DescribeEvents | イベント詳細を照会します | クラスター操作イベントには、クラスター作成、クラスター変更、ノードプール作成、ノードプールスケールアウト、アドオンインストール、クラスタースペックアップが含まれます。DescribeEvents 操作を呼び出して、特定のタイプのイベントの詳細(イベントレベル、イベントステータス、イベント時間など)をクエリできます。 |
| DescribeClusterEvents | 指定されたクラスターのイベントを照会します | クラスター操作イベントには、クラスターの作成、クラスターの変更、ノードプールの作成、ノードプールのスケールアウト、アドオンのインストール、クラスターのスペックアップが含まれます。DescribeClusterEvents 操作を呼び出して、指定されたクラスターで発生したイベントのリストを取得し、イベントレベル、イベントステータス、イベント時間などのイベント詳細をクエリできます。 |
タスク
|
API |
タイトル |
説明 |
| DescribeTaskInfo | タスク詳細の照会 | クラスタータスクの詳細(タスクタイプ、実行ステータス、実行ステージなど)を照会します。 |
| PauseTask | PauseTask | PauseTask 操作を呼び出して、実行中のクラスタータスクを一時停止できます。 |
| ResumeTask | タスクの再開 | 一時停止中のクラスタータスクを再開します。 |
| CancelTask | タスクをキャンセルします | クラスタータスクの実行をキャンセルします。 |
| DescribeClusterTasks | クラスタータスクの照会 | DescribeClusterTasks操作を呼び出して、クラスターのタスクリストを照会します。 |
O&M プラン
|
API |
タイトル |
説明 |
| ListOperationPlansForRegion | 指定リージョンの自動運用保守実行プランの照会 | 指定されたリージョンの最新100件の自動運用保守実行プランを照会します。クラスターのインテリジェント管理モード(Auto Mode)、クラスターの自動アップグレード、ノードプールの自動運用保守などの機能が有効になっている場合、このオペレーションを呼び出して、クラスターのアップグレードやノードプールのCVE修正など、システムによって自動生成された運用保守プランとその実行ステータスを照会できます。 |
| ListOperationPlans | 自動運用保守の実行計画を照会します | 自動運用保守の実行計画のリストを取得します。 |
| CancelOperationPlan | 自動運用保守タスク実行プランのキャンセル | 既存の未実行の自動運用保守タスク実行プランをキャンセルします。 |
その他
|
API |
タイトル |
説明 |
| GetUpgradeStatus | (Deprecated) Query cluster upgrade status | クラスター ID を指定して、クラスターのスペックアップステータスを照会します。 [_single.title](非推奨) クラスターのスペックアップステータスを照会します。 [_single.title](非推奨) クラスターのスペックアップステータスを照会します |
| PauseClusterUpgrade | (非推奨)クラスターのアップグレードを一時停止する | クラスターのアップグレードを一時停止します。 [_single.title](非推奨) クラスターのアップグレードを一時停止します。 |
| CancelClusterUpgrade | クラスターのスペックアップをキャンセルします(非推奨) | アップグレード中の状態にある ACK クラスターのスペックアップをキャンセルします。 |
| ResumeUpgradeCluster | (Deprecated) Resume cluster upgrade | クラスター ID に基づいて、スペックアップ一時停止状態のクラスターのスペックアップを再開します。 [_single.title](非推奨) クラスターのスペックアップを再開します。 [_single.title](非推奨) クラスターのスペックアップを再開します |
| DescribeAddons | (Deprecated) Query cluster component details | プラットフォームでサポートされているすべてのコンポーネントの詳細を照会します。 [_single.title](非推奨) クラスターコンポーネントの詳細を照会します [_single.title](非推奨) クラスターコンポーネントの詳細を照会します |
| DescribeClusterAddonsVersion | (Deprecated) Query Cluster Component Versions | クラスター ID を指定して、クラスターにインストールされているすべてのコンポーネントの詳細を照会します。 [_single.title](非推奨) クラスターコンポーネントバージョンを照会します [_single.title](非推奨) クラスターコンポーネントバージョンを照会します |
| DescribeClusterAddonInstance | (Deprecated) Query cluster component instance information | DescribeClusterAddonInstance を呼び出して、インストール済みのクラスターコンポーネントのバージョン、ステータス、構成などの情報を照会します。 [_single.title](非推奨) クラスターコンポーネントインスタンス情報を照会します [_single.title](非推奨) クラスターコンポーネントインスタンス情報を照会します |
| DescribeClusterAddonMetadata | (Deprecated) Query cluster component metadata | 特定のクラスターで使用できる指定されたコンポーネントのバージョン情報(コンポーネントバージョンおよび設定可能なパラメーターを含む)を照会します。 [_single.title](非推奨) クラスターコンポーネントメタデータを照会します。 |
| DescribeClusterAddonsUpgradeStatus | (Deprecated) Query cluster component upgrade status | コンポーネント名でコンポーネントのスペックアップステータスを照会します。 [_single.title](非推奨) クラスターコンポーネントのスペックアップステータスを照会します [_single.title](非推奨) クラスターコンポーネントのスペックアップステータスを照会します |
| UpdateNodePoolComponent | ノードコンポーネントを更新します | ノードコンポーネントを更新します。 |
| InstallNodePoolComponents | ノードコンポーネントをインストールします | ノードにコンポーネントをインストールします。コンポーネントをインストールするノードを構成および指定できます。 |
| UpdateKMSEncryption | Secret 保存時暗号化構成を更新します | クラスター ID を指定して、クラスターの Secret 保存時暗号化構成を更新します。 |
| CreateAutoRepairPolicy | 自己修復ルールの作成 | 自己修復ルールを作成します。 |
| DeleteAutoRepairPolicy | 自動障害復旧ルールを削除します | 自動障害復旧ルールを削除します。 |
| ModifyAutoRepairPolicy | 自己修復ルールを変更します | 自己修復ルールを変更します。 |
| DescribeAutoRepairPolicy | DescribeAutoRepairPolicy | 自動修復ルールを照会します。 |
| ListAutoRepairPolicies | 自動修復ポリシーのリストを取得します | 自動修復ポリシーのリストを取得します。 |