すべてのプロダクト
Search

このプロダクト

    Microservices Engine:ListClusters

    ドキュメントセンター

    Microservices Engine:ListClusters

    最終更新日:Apr 18, 2026

    登録・設定センターのクラスターを一覧表示します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mse:ListClusters

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RequestPars

    string

    任意

    JSON 形式の拡張リクエストパラメーター。

    {}
    PageNum

    integer

    必須

    返すページ番号。

    1
    PageSize

    integer

    必須

    ページあたりのクラスター数。

    10
    ClusterAliasName

    string

    任意

    クラスターエイリアス。このパラメーターはあいまい一致をサポートします。

    cluster
    RegionId

    string

    必須

    クラスターがデプロイされている MSE リージョンの ID。

    cn-hangzhou
    ResourceGroupId

    string

    任意

    リソースグループの ID。詳細については、「リソースグループの基本情報を表示」をご参照ください。

    rg-acfmxbzafebvvfa
    Tag

    array<object>

    任意

    タグのリスト。最大 20 個のタグを指定できます。

    object

    任意

    タグ。

    Key

    string

    任意

    タグキー。

    env
    Value

    string

    任意

    タグ値。

    prd
    KeyId

    string

    任意

    Nacos クラスターの場合、指定されたキー ID にバインドされたインスタンスを持つクラスターを返します。

    key-hzz67774641bsp21vhj4h
    AcceptLanguage

    string

    任意

    応答言語。有効な値：

    • zh：中国語

    • en：英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    HttpCode

    string

    HTTP ステータスコード。

    202
    TotalCount

    integer

    インスタンスの総数。

    7
    RequestId

    string

    リクエスト ID。

    69AD2AA7-DB47-449B-941B-B14409DF****
    Message

    string

    応答メッセージ。

    OK
    PageSize

    integer

    ページあたりのインスタンス数。

    10
    PageNumber

    integer

    ページ番号。

    1
    Data

    array<object>

    クラスターのリスト。

    array<object>

    クラスターの詳細。

    EndDate

    string

    クラスターのサブスクリプションの有効期限が切れる時間。

    2021-08-01 00:00:00
    IntranetDomain

    string

    クラスターのイントラネットドメイン名。

    mse-7413****-eureka.mse.aliyuncs.com
    InternetDomain

    string

    クラスターのインターネットドメイン名。

    mse-7413****-p.eureka.mse.aliyuncs.com
    CreateTime

    string

    クラスターが作成された時間。

    2020-07-31 11:36:08
    ChargeType

    string

    課金方法。有効な値： subscription および pay-as-you-go。

    subscription
    IntranetAddress

    string

    クラスターのイントラネット IP アドレス。

    192.168.XX.XX
    InstanceId

    string

    インスタンス ID。

    mse-cn-st21ri2****
    InternetAddress

    string

    クラスターのインターネット IP アドレス。

    47.98.XX.XX
    ClusterAliasName

    string

    クラスターエイリアス。

    mse-7413****
    ClusterType

    string

    クラスタータイプ。有効な値： ZooKeeper、Nacos-Ans、Eureka。

    Eureka
    InitStatus

    string

    初期化ステータス。

    RESTART_SUCCESS
    AppVersion

    string

    アプリケーションバージョン。

    1.9.3
    CanUpdate

    boolean

    クラスターをアップグレードできるかどうかを示します。

    true
    VersionCode

    string

    クラスターバージョンのコード。

    EUREKA_1_9_3
    InstanceCount

    integer

    クラスター内のインスタンス数。

    2
    ClusterName

    string

    クラスター名。

    mse-cn-st21ri2****
    MseVersion

    string

    クラスターのエディション。

    mse_pro
    Tags

    object

    クラスターにアタッチされたタグ。

    ResourceGroupId

    string

    クラスターが含まれるリソースグループの ID。

    rg-acfmv7jiavm4uxa
    VpcId

    string

    クラスターがデプロイされている VPC の ID。

    vpc-bp1hcg467ekqsv0zr****
    MaintenancePeriod

    object

    メンテナンスウィンドウ。

    StartTime

    string

    メンテナンスウィンドウの開始時刻。

    02:00
    EndTime

    string

    メンテナンスウィンドウの終了時刻。

    06:00
    VersionLifecycle

    string

    バージョンライフサイクル。

    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコード。

    mse-100-000
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "69AD2AA7-DB47-449B-941B-B14409DF****",
  "Message": "OK",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "EndDate": "2021-08-01 00:00:00",
      "IntranetDomain": "mse-7413****-eureka.mse.aliyuncs.com",
      "InternetDomain": "mse-7413****-p.eureka.mse.aliyuncs.com",
      "CreateTime": "2020-07-31 11:36:08",
      "ChargeType": "subscription",
      "IntranetAddress": "192.168.XX.XX",
      "InstanceId": "mse-cn-st21ri2****",
      "InternetAddress": "47.98.XX.XX",
      "ClusterAliasName": "mse-7413****",
      "ClusterType": "Eureka",
      "InitStatus": "RESTART_SUCCESS",
      "AppVersion": "1.9.3",
      "CanUpdate": true,
      "VersionCode": "EUREKA_1_9_3",
      "InstanceCount": 2,
      "ClusterName": "mse-cn-st21ri2****",
      "MseVersion": "mse_pro",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "ResourceGroupId": "rg-acfmv7jiavm4uxa",
      "VpcId": "vpc-bp1hcg467ekqsv0zr****",
      "MaintenancePeriod": {
        "StartTime": "02:00",
        "EndTime": "06:00"
      },
      "VersionLifecycle": ""
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalRequest Invalid request:%s
    400 InvalidParameter Parameter error:%s
    500 InternalError Console error. Try again later:%s
    403 NoPermission You are not authorized to perform this operation:%s
    404 NotFound Not found:%s

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

    変更履歴

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