CheckControlPlaneLogEnable - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

ログの保存期間やログ収集コンポーネントなど、コントロールプレーンコンポーネントの現在のログ構成を照会します。Container Service for Kubernetes (ACK) のマネージドクラスターでは、コントロールプレーンコンポーネントのログを収集し、Simple Log Service のプロジェクトに配信できます。対象となるコントロールプレーンコンポーネントには、Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager が含まれます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:CheckControlPlaneLogEnable

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

なし

リクエスト構文

GET /clusters/{ClusterId}/controlplanelog HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスター ID。	c5b5e80b0b64a4bf6939d2d8fbbc5****

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object
log_project	string	コントロールプレーンコンポーネントのログを保存するために使用する Simple Log Service プロジェクトの名前です。デフォルト値： k8s-log-$Cluster ID。	k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****
log_ttl	string	Logstore に保存されるログデータの保存期間です。有効な値の範囲は 1～3000、単位は日です。デフォルト値： 30。	30
aliuid	string	リソースが属する Alibaba Cloud アカウントの ID です。	162981*****
components	array	ログ収集が有効になっているコントロールプレーンコンポーネントです。
	string	ログ収集が有効になっているコントロールプレーンコンポーネントです。デフォルトでは、次のコントロールプレーンコンポーネントに対してログ収集が有効になっています： `apiserver`、`ccm`、`scheduler`、`kcm`、`controlplane-events`。	["apiserver", "ccm", "scheduler", "kcm", "controlplane-events", alb]

例

成功レスポンス

JSONJSON

{
  "log_project": "k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****",
  "log_ttl": "30",
  "aliuid": "162981*****",
  "components": [
    "[\"apiserver\", \"ccm\", \"scheduler\",  \"kcm\", \"controlplane-events\", alb]"
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。