QueryClusterDetail - - Alibaba Cloud ドキュメントセンター

クラスターの詳細を照会します。

今すぐお試しください

この 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:QueryClusterDetail

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	インスタンスの ID。	mse-cn-st21ri2****
OrderId	string	任意	注文の ID。	20576750143****
AclSwitch	boolean	任意	アクセス制御リスト (ACL) を照会するかどうかを指定します。	false
AcceptLanguage	string	任意	応答の言語。有効な値： zh：中国語 en：英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	文字列オブジェクト。
Message	string	返されるメッセージ。	The request is successfully processed.
RequestId	string	リクエスト ID。	9515ACA4-E94D-440D-989E-C379FCED****
Data	object	返されるデータ。
VpcId	string	VPC の ID。	vpc-bp1hcg467ekqsv0zr****
CreateTime	string	クラスターが作成された時間。	2020-07-31 11:36:08
IntranetAddress	string	プライベートエンドポイント。	192.168.XX.XX
DiskType	string	ディスクのタイプ。	alicloud-disk-ssd-multi-zone
PubNetworkFlow	string	パブリック帯域幅。単位：Mbit/s。有効な値：0～5000。値が 0 の場合は、パブリック帯域幅が使用されていないことを示します。	3
DiskCapacity	integer	ディスクの容量。単位：GB。	60
MemoryCapacity	integer	メモリ容量。単位：GB。	2
ClusterAliasName	string	クラスターのエイリアス。	mse-7413****
InstanceCount	integer	クラスター内のインスタンス数。	3
IntranetPort	string	プライベートポート。	8761
InstanceModels	array<object>	インスタンスのリスト。
	object	文字列。
PodName	string	Pod の名前。	mse-7413**-159616656**-reg-center-0-0
SingleTunnelVip	string	シングルスレッドの IP アドレス。	192.168.XX.XX
InternetIp	string	パブリック IP アドレス。	47.98.XX.XX
Ip	string	インスタンスの IP アドレス。	10.12.XX.XX
Role	string	インスタンスのロール。	Peer
HealthStatus	string	インスタンスのヘルスステータス。	Running
CreationTimestamp	string	インスタンスが作成された日時を示すタイムスタンプ。	1578575377732
Zone	string	ゾーン。	cn-shanghai-f
IntranetDomain	string	プライベートエンドポイント。	mse-7413****-eureka.mse.aliyuncs.com
InternetDomain	string	パブリックエンドポイント。	mse-7413****-p.eureka.mse.aliyuncs.com
PayInfo	string	課金方法。有効な値は、サブスクリプションと従量課金です。	Pay-as-you-go
InternetAddress	string	パブリック IP アドレス。	47.98.XX.XX
InstanceId	string	インスタンスの ID。	mse-cn-st21ri2****
AclEntryList	string	ホワイトリスト。	[]
HealthStatus	string	クラスターのヘルスステータス。	RESTART_SUCCESS
InitCostTime	integer	クラスターの作成にかかった時間。単位：ms。	98408
RegionId	string	リージョンの ID。	cn-hangzhou
AclId	string	ホワイトリストの ID。	acl-bp17020kiqvzutwwj****
Cpu	integer	CPU コアの数。	1
ClusterType	string	クラスターのタイプ。有効な値：ZooKeeper、Nacos-Ans、Eureka。	Nacos-Ans
ClusterName	string	クラスターの名前。	mse-bc1a29b0-160230875****
InitStatus	string	クラスターの作成ステータス。	RESTART_SUCCESS
InternetPort	string	プライベートネットワークのポートです。	8761
AppVersion	string	アプリケーションのバージョン。	1.2.1
NetType	string	ネットワークタイプ。有効な値： `privatenet`：VPC。 `pubnet`：パブリックネットワーク。	privatenet
ClusterVersion	string	クラスターのバージョン。	1.2.1
ClusterSpecification	string	エンジンの仕様。	MSE_SC_1_2_200_c
VSwitchId	string	vSwitch の ID。	vsw-xxx-xxxx
ConnectionType	string	ネットワーク接続のタイプ。有効な値： slb eni	slb
MseVersion	string	MSE のバージョン。	mse_basic
ChargeType	string	課金方法。有効な値は、サブスクリプションと従量課金です。	Pay-as-you-go
OrderClusterVersion	string	元の注文におけるクラスターのバージョン。	1.2.0
Tags	object	インスタンスにアタッチされたタグ。
ResourceGroupId	string	リソースグループの ID。	rg-aek2dhgysj*****
VersionLifecycle	string
ErrorCode	string	エラーコード。	mse-100-000
Success	boolean	リクエストが成功したかどうかを示します。有効な値： `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "Message": "The request is successfully processed.\n",
  "RequestId": "9515ACA4-E94D-440D-989E-C379FCED****",
  "Data": {
    "VpcId": "vpc-bp1hcg467ekqsv0zr****",
    "CreateTime": "2020-07-31 11:36:08",
    "IntranetAddress": "192.168.XX.XX",
    "DiskType": "alicloud-disk-ssd-multi-zone",
    "PubNetworkFlow": "3",
    "DiskCapacity": 60,
    "MemoryCapacity": 2,
    "ClusterAliasName": "mse-7413****",
    "InstanceCount": 3,
    "IntranetPort": "8761",
    "InstanceModels": [
      {
        "PodName": "mse-7413****-159616656****-reg-center-0-0",
        "SingleTunnelVip": "192.168.XX.XX",
        "InternetIp": "47.98.XX.XX",
        "Ip": "10.12.XX.XX",
        "Role": "Peer",
        "HealthStatus": "Running",
        "CreationTimestamp": "1578575377732",
        "Zone": "cn-shanghai-f"
      }
    ],
    "IntranetDomain": "mse-7413****-eureka.mse.aliyuncs.com",
    "InternetDomain": "mse-7413****-p.eureka.mse.aliyuncs.com",
    "PayInfo": "Pay-as-you-go\n",
    "InternetAddress": "47.98.XX.XX",
    "InstanceId": "mse-cn-st21ri2****",
    "AclEntryList": "[]",
    "HealthStatus": "RESTART_SUCCESS",
    "InitCostTime": 98408,
    "RegionId": "cn-hangzhou",
    "AclId": "acl-bp17020kiqvzutwwj****",
    "Cpu": 1,
    "ClusterType": "Nacos-Ans",
    "ClusterName": "mse-bc1a29b0-160230875****",
    "InitStatus": "RESTART_SUCCESS",
    "InternetPort": "8761",
    "AppVersion": "1.2.1",
    "NetType": "privatenet",
    "ClusterVersion": "1.2.1",
    "ClusterSpecification": "MSE_SC_1_2_200_c",
    "VSwitchId": "vsw-xxx-xxxx",
    "ConnectionType": "slb",
    "MseVersion": "mse_basic",
    "ChargeType": "Pay-as-you-go\n",
    "OrderClusterVersion": "1.2.0",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ResourceGroupId": "rg-aek2dhgysj*****",
    "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

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

変更履歴

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