すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Service Mesh:DescribeNamespaceScopeSidecarConfig

    ドキュメントセンター

    Alibaba Cloud Service Mesh:DescribeNamespaceScopeSidecarConfig

    最終更新日:Feb 06, 2026

    DescribeNamespaceScopeSidecarConfig を呼び出して、名前空間レベルのサイドカー構成を照会します。

    操作説明

    DescribeASMSidecarExpectedVersion を使用して、Service Mesh (ASM) データプレーン内のサイドカーの期待されるバージョンを照会します。たとえば、Pod に v1.11 のサイドカーがある場合、Service Mesh (ASM) インスタンスを v1.12 にアップグレードしても Pod を再起動しないとします。サイドカーは実際のバージョン (v1.11) で実行され続けますが、DescribeASMSidecarExpectedVersion API は期待されるバージョンである v1.12 を返します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    servicemesh:DescribeNamespaceScopeSidecarConfig

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ServiceMeshId

    string

    必須

    Service Mesh (ASM) インスタンス ID。

    c7120e75a202d4fd8acb028a86b6a****
    Namespace

    string

    任意

    名前空間。

    default

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答本文。

    RequestId

    string

    リクエスト ID。

    31d3a0f0-07ed-4f6e-9004-1804498c****
    ConfigPatches

    object

    名前空間のサイドカープロキシの構成。

    TerminationDrainDuration

    string

    サイドカープロキシの終了ドレイン期間。

    6s
    SidecarProxyInitResourceLimit

    object

    サイドカープロキシの初期化コンテナーのリソース制限。

    ResourceCPULimit

    string

    CPU リソース制限。

    2000 m
    ResourceMemoryLimit

    string

    メモリリソース制限。

    50 Mi
    SidecarProxyInitResourceRequest

    object

    サイドカープロキシの初期化コンテナーのリソース要求。

    ResourceCPURequest

    string

    CPU リソース要求。

    60 m
    ResourceMemoryRequest

    string

    メモリリソース要求。

    30 Mi
    SidecarProxyResourceLimit

    object

    サイドカープロキシコンテナーのリソース制限。

    ResourceCPULimit

    string

    CPU リソース制限。

    2000 m
    ResourceMemoryLimit

    string

    メモリリソース制限。

    50 Mi
    SidecarProxyResourceRequest

    object

    サイドカープロキシコンテナーのリソース要求。

    ResourceCPURequest

    string

    CPU リソース要求。

    60 m
    ResourceMemoryRequest

    string

    メモリリソース要求。

    30 Mi
    ExcludeOutboundPorts

    string

    サイドカープロキシのインターセプトから除外するアウトバウンドトラフィックポート。

    81
    ExcludeOutboundIPRanges

    string

    サイドカープロキシのインターセプトから除外するアウトバウンドトラフィック IP 範囲。

    192.168.1.3/31
    IncludeOutboundIPRanges

    string

    サイドカープロキシのインターセプトに含めるアウトバウンドトラフィック IP 範囲。

    192.168.1.4/31
    ExcludeInboundPorts

    string

    サイドカープロキシのインターセプトから除外するインバウンドトラフィックポート。

    82
    IncludeInboundPorts

    string

    サイドカープロキシのインターセプトに含めるインバウンドトラフィックポート。

    83
    IncludeOutboundPorts

    string

    サイドカープロキシのインターセプトに含めるアウトバウンドトラフィックポート。

    84
    IstioDNSProxyEnabled

    boolean

    DNS プロキシ機能を有効にするかどうかを指定します。有効な値:

    • true: DNS プロキシ機能を有効にします。

    • false: DNS プロキシ機能を無効にします。

    true
    LifecycleStr

    string

    JSON 文字列として定義されたサイドカープロキシのライフサイクル。

    {"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}}
    Concurrency

    integer

    istio-proxy のワーカースレッド数。

    2
    LogLevel

    string

    ログレベル。有効な値: info、debug、trace、および error。

    info
    HoldApplicationUntilProxyStarts

    boolean

    アプリケーションコンテナーが istio-proxy コンテナーが準備完了になるまで待機してから開始するかどうかを指定します。有効な値:

    • true: istio-proxy コンテナーが準備完了になるまで待機します。

    • false: istio-proxy コンテナーが準備完了になるまで待機しません。

    true
    ProxyStatsMatcher

    object

    Envoy モニタリングのメトリック。

    InclusionPrefixes

    array

    Envoy モニタリングに含めるメトリックのプレフィックス。

    string

    Envoy モニタリングに含めるメトリックのプレフィックス。

    server
    InclusionSuffixes

    array

    Envoy モニタリングに含めるメトリックのサフィックス。

    string

    Envoy モニタリングに含めるメトリックのサフィックス。

    cluster.outbound
    InclusionRegexps

    array

    Envoy モニタリングにメトリックを含めるための正規表現。

    string

    Envoy モニタリングにメトリックを含めるための正規表現。

    listener.*.downstream_cx_total
    Tracing

    object

    カスタムトレース構成。

    Sampling

    number

    トレースのサンプリングレート。

    99.8
    CustomTags

    object

    レポートされるトレースに追加するカスタムタグ。キーはカスタムタグ名です。値は、タグの値を取得する方法を定義する JSON オブジェクトです。値は次のいずれかの方法で取得できます。

    • literal: タグには静的な値があります。JSON オブジェクトには、リテラル値を指定するための value フィールドが含まれている必要があります。例: {"value":"test"}。

    • header: タグはリクエストヘッダーから値を取得します。JSON オブジェクトには name および defaultValue フィールドが含まれている必要があります。name フィールドはリクエストヘッダーの名前を指定し、defaultValue フィールドはフォールバック値を提供します。例: {"name":"test","defaultValue":"test"}。

    • environment: タグは環境変数から値を取得します。JSON オブジェクトには name および defaultValue フィールドが含まれている必要があります。name フィールドは環境変数の名前を指定し、defaultValue フィールドはフォールバック値を提供します。例: {"name":"test","defaultValue":"test"}。

    {"test":{"literal":{"value":"test"}}}
    MaxPathTagLength

    integer

    トレースタグの最大長。

    10
    InterceptionMode

    string

    サイドカーのトラフィックインターセプトモード。有効な値:

    • REDIRECT: デフォルトモード。サイドカープロキシは iptables リダイレクトを使用してトラフィックをインターセプトします。

    • TPROXY: 透明なプロキシモード。サイドカープロキシは TPROXY を使用してトラフィックをインターセプトします。

    TPROXY
    ProxyMetadata

    object

    サイドカープロキシの追加の環境変数。キーは変数名であり、値はそれに対応する値です。

    string

    追加の環境変数の値。

    "true"
    SidecarProxyInitAckSloResource

    object

    サイドカープロキシの初期化コンテナーのリソース制限とリソース要求。ACK (Container Service for Kubernetes) 動的オーバーコミットリソースとして指定されます。これらの設定は、Pod に ACK 動的オーバーコミットラベル labelkoordinator.sh/qosClass がある場合に適用されます。

    Requests

    object

    サイドカープロキシの初期化コンテナーのリソース要求。ACK 動的オーバーコミットリソースとして指定されます。これらの設定は、Pod に ACK 動的オーバーコミットラベル labelkoordinator.sh/qosClass がある場合に適用されます。オブジェクトには、次のリソースタイプのキーを含めることができます。

    • kubernetes.io/batch-cpu: ACK オーバーコミットタイプの CPU リソース。単位: ミリコア。

    • kubernetes.io/batch-memory: ACK オーバーコミットタイプのメモリリソース。

    string

    サイドカープロキシの初期化コンテナーのリソース要求の値。

    128Mi
    Limits

    object

    サイドカープロキシの初期化コンテナーのリソース制限。ACK 動的オーバーコミットリソースとして指定されます。これらの設定は、Pod に ACK 動的オーバーコミットラベル labelkoordinator.sh/qosClass がある場合に適用されます。オブジェクトには、次のリソースタイプのキーを含めることができます。

    • kubernetes.io/batch-cpu: ACK オーバーコミットタイプの CPU リソース。単位: ミリコア。

    • kubernetes.io/batch-memory: ACK オーバーコミットタイプのメモリリソース。

    string

    サイドカープロキシの初期化コンテナーのリソース制限の値。

    2048Mi
    SidecarProxyAckSloResource

    object

    サイドカープロキシコンテナーのリソース設定。ACK 動的オーバーコミットリソースとして指定されます。これらの設定は、Pod に ACK 動的オーバーコミットラベル labelkoordinator.sh/qosClass がある場合に使用されます。

    Requests

    object

    サイドカープロキシコンテナーのリソース要求。ACK 動的オーバーコミットリソースとして指定されます。これらの設定は、Pod に ACK 動的オーバーコミットラベル labelkoordinator.sh/qosClass がある場合に適用されます。オブジェクトには、次のリソースタイプのキーを含めることができます。

    • kubernetes.io/batch-cpu: ACK オーバーコミットタイプの CPU リソース。単位: ミリコア。

    • kubernetes.io/batch-memory: ACK オーバーコミットタイプのメモリリソース。

    string

    サイドカープロキシコンテナーのリソース要求の値。

    128Mi
    Limits

    object

    サイドカープロキシコンテナーのリソース制限。ACK 動的オーバーコミットリソースとして指定されます。これらの設定は、Pod に ACK 動的オーバーコミットラベル labelkoordinator.sh/qosClass がある場合に適用されます。オブジェクトには、次のリソースタイプのキーを含めることができます。

    • kubernetes.io/batch-cpu: ACK オーバーコミットタイプの CPU リソース。単位: ミリコア。

    • kubernetes.io/batch-memory: ACK オーバーコミットタイプのメモリリソース。

    string

    サイドカープロキシコンテナーのリソース制限の値。

    2048Mi
    Privileged

    boolean

    サイドカープロキシコンテナーを特権モードで実行するかどうかを指定します。有効な値:

    • true: サイドカープロキシコンテナーは特権モードで実行されます。

    • false: サイドカープロキシコンテナーは特権モードで実行されません。

    false
    EnableCoreDump

    boolean

    サイドカープロキシコンテナーのコアダンプを有効にするかどうかを指定します。有効な値:

    • true: コアダンプを有効にします。

    • false: コアダンプを無効にします。

    false
    ReadinessInitialDelaySeconds

    integer

    サイドカープロキシコンテナーで最初の readiness プローブが実行されるまでの遅延秒数。

    2
    ReadinessPeriodSeconds

    integer

    サイドカープロキシコンテナーの readiness プローブ間の間隔秒数。

    3
    ReadinessFailureThreshold

    integer

    サイドカープロキシコンテナーが準備完了ではないとマークされるまでの、連続して失敗した readiness プローブの数。

    5
    SMCConfiguration

    object

    SMC-R 最適化の構成。

    Enabled

    boolean

    SMC-R 最適化を有効または無効にします。SMC-R はノード間通信パフォーマンスを向上させ、Alibaba Cloud Linux 3 とノード上の弾力性のある Remote Direct Memory Access (eRDMA) ネットワークデバイスを必要とします。

    true
    RuntimeValues

    object

    Envoy プロキシの実行時パラメーター。

    string

    Envoy 実行時パラメーターの値。

    "65536"
    ScaledSidecarResource

    object

    指定されたパーセンテージに基づいてサイドカーリソースを動的にスケーリングするための設定。

    ResourceCalculationStrategy

    string

    サイドカーリソースの計算戦略。

    ContainerRef

    string

    サイドカーリソースを計算するためのベースラインコンテナー。

    ResourcePercentage

    integer

    サイドカーのリソースパーセンテージ。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "ConfigPatches": {
    "TerminationDrainDuration": "6s",
    "SidecarProxyInitResourceLimit": {
      "ResourceCPULimit": "2000 m",
      "ResourceMemoryLimit": "50 Mi"
    },
    "SidecarProxyInitResourceRequest": {
      "ResourceCPURequest": "60 m",
      "ResourceMemoryRequest": "30 Mi"
    },
    "SidecarProxyResourceLimit": {
      "ResourceCPULimit": "2000 m",
      "ResourceMemoryLimit": "50 Mi"
    },
    "SidecarProxyResourceRequest": {
      "ResourceCPURequest": "60 m",
      "ResourceMemoryRequest": "30 Mi"
    },
    "ExcludeOutboundPorts": "81",
    "ExcludeOutboundIPRanges": "192.168.1.3/31",
    "IncludeOutboundIPRanges": "192.168.1.4/31",
    "ExcludeInboundPorts": "82",
    "IncludeInboundPorts": "83",
    "IncludeOutboundPorts": "84",
    "IstioDNSProxyEnabled": true,
    "LifecycleStr": "{\"postStart\":{\"exec\":{\"command\":[\"pilot-agent\",\"wait\"]}},\"preStop\":{\"exec\":{\"command\":[\"/bin/sh\",\"-c\",\"sleep 15\"]}}}",
    "Concurrency": 2,
    "LogLevel": "info",
    "HoldApplicationUntilProxyStarts": true,
    "ProxyStatsMatcher": {
      "InclusionPrefixes": [
        "server"
      ],
      "InclusionSuffixes": [
        "cluster.outbound"
      ],
      "InclusionRegexps": [
        "listener.*.downstream_cx_total"
      ]
    },
    "Tracing": {
      "Sampling": 99.8,
      "CustomTags": {
        "test": {
          "literal": {
            "value": "test"
          }
        }
      },
      "MaxPathTagLength": 10
    },
    "InterceptionMode": "TPROXY",
    "ProxyMetadata": {
      "key": "\"true\""
    },
    "SidecarProxyInitAckSloResource": {
      "Requests": {
        "key": "128Mi"
      },
      "Limits": {
        "key": "2048Mi"
      }
    },
    "SidecarProxyAckSloResource": {
      "Requests": {
        "key": "128Mi"
      },
      "Limits": {
        "key": "2048Mi"
      }
    },
    "Privileged": false,
    "EnableCoreDump": false,
    "ReadinessInitialDelaySeconds": 2,
    "ReadinessPeriodSeconds": 3,
    "ReadinessFailureThreshold": 5,
    "SMCConfiguration": {
      "Enabled": true
    },
    "RuntimeValues": {
      "key": "\"65536\""
    },
    "ScaledSidecarResource": {
      "ResourceCalculationStrategy": "",
      "ContainerRef": "",
      "ResourcePercentage": 0
    }
  }
}

    エラーコード

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

    変更履歴

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