Gunakan API QueryClusterDetail untuk Ambil Detail Kluster MSE - MSE - Alibaba Cloud - Microservices Engine

Mengkueri detail kluster.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

mse:QueryClusterDetail

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	No	ID instans.	mse-cn-st21ri2****
OrderId	string	No	ID pesanan.	20576750143****
AclSwitch	boolean	No	Apakah akan mengkueri daftar Kontrol akses (ACL).	false
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Bahasa Mandarin en: Bahasa Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	The data returned by the request.
Message	string	The returned message.	请求处理成功
RequestId	string	The request ID.	9515ACA4-E94D-440D-989E-C379FCED****
Data	object	The details of the cluster.
VpcId	string	The ID of the VPC.	vpc-bp1hcg467ekqsv0zr****
CreateTime	string	The creation time of the cluster.	2020-07-31 11:36:08
IntranetAddress	string	The private address.	192.168.XX.XX
DiskType	string	The disk type.	alicloud-disk-ssd-multi-zone
PubNetworkFlow	string	The public bandwidth in Mbit/s. The value is an integer from 0 to 5,000. A value of 0 indicates that the cluster is not accessible over the public network.	3
DiskCapacity	integer	The disk capacity in GB.	60
MemoryCapacity	integer	The memory capacity in GB.	2
ClusterAliasName	string	The alias of the cluster.	mse-7413****
InstanceCount	integer	The number of instances in the cluster.	3
IntranetPort	string	The private port.	8761
InstanceModels	array<object>	The list of instances in the cluster.
	object	An instance in the cluster.
PodName	string	The name of the pod.	mse-7413**-159616656**-reg-center-0-0
SingleTunnelVip	string	The single-threaded IP address.	192.168.XX.XX
InternetIp	string	The public IP address.	47.98.XX.XX
Ip	string	The IP address of the instance.	10.12.XX.XX
Role	string	The role of the instance.	Peer
HealthStatus	string	The health status of the instance.	Running
CreationTimestamp	string	The timestamp that indicates when the instance was created.	1578575377732
Zone	string	The zone.	cn-shanghai-f
IntranetDomain	string	The private domain name.	mse-7413****-eureka.mse.aliyuncs.com
InternetDomain	string	The public domain name.	mse-7413****-p.eureka.mse.aliyuncs.com
PayInfo	string	Specifies the billing method, which is either `subscription` or `pay-as-you-go`.	按量付费
InternetAddress	string	The public address.	47.98.XX.XX
InstanceId	string	The ID of the instance.	mse-cn-st21ri2****
AclEntryList	string	The IP address whitelist.	[]
HealthStatus	string	The health status of the cluster.	RESTART_SUCCESS
InitCostTime	integer	The time it took to create the cluster, in milliseconds.	98408
RegionId	string	The ID of the region.	cn-hangzhou
AclId	string	The ID of the whitelist.	acl-bp17020kiqvzutwwj****
Cpu	integer	The number of CPU cores.	1
ClusterType	string	The type of the cluster. Valid values: `ZooKeeper`, `Nacos-Ans`, and `Eureka`.	Nacos-Ans
ClusterName	string	The name of the cluster.	mse-bc1a29b0-160230875****
InitStatus	string	The creation status of the cluster.	RESTART_SUCCESS
InternetPort	string	The public port.	8761
AppVersion	string	The application version.	1.2.1
NetType	string	The network type. Valid values: `privatenet`: The cluster is deployed in a VPC. `pubnet`: The cluster is accessible over the public network.	privatenet
ClusterVersion	string	The version of the cluster.	1.2.1
ClusterSpecification	string	The specifications of the cluster.	MSE_SC_1_2_200_c
VSwitchId	string	The ID of the vSwitch.	vsw-xxx-xxxx
ConnectionType	string	The network connection type. Valid values: `slb`: Server Load Balancer (SLB) `eni`: Elastic Network Interface (ENI)	slb
MseVersion	string	The edition of the Microservices Engine (MSE) instance.	mse_basic
ChargeType	string	Specifies the billing method, which is either `subscription` or `pay-as-you-go`.	按量付费
OrderClusterVersion	string	The originally purchased cluster version.	1.2.0
Tags	object	The tags attached to the instance.
ResourceGroupId	string	The ID of the resource group.	rg-aek2dhgysj*****
VersionLifecycle	string	The lifecycle status of the cluster version.
ErrorCode	string	The error code.	mse-100-000
Success	boolean	Indicates whether the request succeeded. Valid values: `true`: The request succeeded. `false`: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "Message": "请求处理成功",
  "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": "按量付费",
    "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": "按量付费",
    "OrderClusterVersion": "1.2.0",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ResourceGroupId": "rg-aek2dhgysj*****",
    "VersionLifecycle": ""
  },
  "ErrorCode": "mse-100-000",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
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

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.