Microservices Engine:ListClusterHealthCheckTask-Microservices Engine-Alibaba Cloud - Microservices Engine

Mengambil informasi tentang Tugas Pemeriksaan kesehatan historis dalam format.

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:ListClusterHealthCheckTask

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	No	ID Instans.	mse_prepaid_public_cn-7pp2o4wfx01
PageNum	integer	No	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	No	Jumlah entri per halaman.	10
RegionId	string	No	Wilayah tempat Kluster berada.	cn-hangzhou
RequestPars	string	No	Parameter permintaan tambahan dalam format JSON.	{}
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Mandarin en: Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	The request ID.	4E9FDCFE-0738-493B-B801-82BDFBCB****
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	Code is only used to synchronize with success	200
ErrorCode	string	The error code. Take note of the following items: Successful request: The ErrorCode field is not returned. Failed request: The ErrorCode field is returned. For more information, see the Error codes section in this topic.	mse-100-000
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	请求处理成功
DynamicCode	string	The dynamic part in the error message.	code
DynamicMessage	string	The dynamic error message used to replace %s in the ErrMessage parameter. Catatan If ErrMessage returns The Value of Input Parameter %s is not valid, and DynamicMessage returns DtsJobId, it indicates that the DtsJobId request parameter is invalid.	The specified parameter is invalid.
Data	object	The data returned.
PageNumber	integer	The page number of the list.	1
TotalSize	integer	The total number of queried rules.	9
PageSize	integer	The number of entries per page.	10
Result	array<object>	The list of health check tasks.
	array<object>	The health check task.
Id	integer	The ID.	1
Score	integer	The total score.	60
TotalItem	integer	The total number of inspection items.	10
TotalRisk	integer	The total number of risk items.	3
InstanceId	string	The instance ID.	mse_ingresspost-cn-0jbvrcex****
ClusterType	string	The type of the instance.	Nacos-Ans
Type	string	Redundant field.	null
Status	string	The job states.	FINISH
PrimaryUser	string	The ID of the user to which the cluster belongs.	123456
Spec	string	The specifications.	MSE_SC_2_4_200_c
Replica	string	The number of nodes in the cluster.	3
VersionCode	string	The version number.	NACOS_ANS_1_2_1_3
AppVersion	string	The complete version number.	1.2.1
ImageVersion	string	Redundant field.	null
CreateTime	string	The time when the task was created.	2022-06-20T06:51:46Z
UpdateTime	string	The time when the instance was last updated.	2022-11-12 15:07:55
RiskList	array<object>	The list of risk items.
	object	The information about risk items.
Id	integer	The ID.	3426
TaskId	integer	The ID of the associated parent task.	1
RiskName	string	The risk name.	引擎版本过低
RiskCode	string	The risk code.	22020010001
PrimaryUser	string	The ID of the user to which the cluster belongs.	123456
Type	integer	Redundant field.	null
Values	string	Redundant field.	null
Module	string	Redundant field.	null
RiskType	string	The type of the risk.	版本风险
RiskLevel	string	The risk level. Valid values: HIGH: High risk MID: Medium risk LOW: Low risk	MID
Suggestion	string	The suggestion.	{\"desc\":\"请尽快升级至最新版本\",\"links\":[{\"type\":\"upgrade\",\"desc\":\"点击升级\"}]}
Situation	string	The current situation.	{\"desc\":\"当前引擎版本过低，有大量功能缺失\",\"links\":[{\"type\":\"url\",\"value\":\"https://xxxx"\",\"desc\":\"版本说明\"}]}
Description	string	The description.	{\"desc\":\"引擎版本过低，有大量功能缺失，请尽快升级至最新版本！\"}
Mute	boolean	Specifies whether to disable the notification feature if the risk item occurs. true: Disables risk item notifications false: Enables risk item notifications	false
NoticeFeature	boolean	Redundant field.	null
RiskNameEn	string	The English name of the risk.	Low engine version
SuggestionEn	string	The English description of the suggestion.	Upgrade to the latest version
SituationEn	string	The English description of the current situation.	The current engine version is low, and there are many missing features
DescriptionEn	string	The English description of the risk.	Upgrade to the latest version to ensure that all features are available!
ChargeType	string	The billing method.	PREPAY

Contoh

Respons sukses

JSONformat

{
  "RequestId": "4E9FDCFE-0738-493B-B801-82BDFBCB****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 9,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Score": 60,
        "TotalItem": 10,
        "TotalRisk": 3,
        "InstanceId": "mse_ingresspost-cn-0jbvrcex****",
        "ClusterType": "Nacos-Ans",
        "Type": "null\n",
        "Status": "FINISH",
        "PrimaryUser": "123456",
        "Spec": "MSE_SC_2_4_200_c",
        "Replica": "3",
        "VersionCode": "NACOS_ANS_1_2_1_3",
        "AppVersion": "1.2.1",
        "ImageVersion": "null",
        "CreateTime": "2022-06-20T06:51:46Z",
        "UpdateTime": "2022-11-12 15:07:55",
        "RiskList": [
          {
            "Id": 3426,
            "TaskId": 1,
            "RiskName": "引擎版本过低",
            "RiskCode": "22020010001",
            "PrimaryUser": "123456",
            "Type": 0,
            "Values": "null",
            "Module": "null",
            "RiskType": "版本风险",
            "RiskLevel": "MID",
            "Suggestion": "{\\\"desc\\\":\\\"请尽快升级至最新版本\\\",\\\"links\\\":[{\\\"type\\\":\\\"upgrade\\\",\\\"desc\\\":\\\"点击升级\\\"}]}",
            "Situation": "{\\\"desc\\\":\\\"当前引擎版本过低，有大量功能缺失\\\",\\\"links\\\":[{\\\"type\\\":\\\"url\\\",\\\"value\\\":\\\"https://xxxx\"\\\",\\\"desc\\\":\\\"版本说明\\\"}]}",
            "Description": "{\\\"desc\\\":\\\"引擎版本过低，有大量功能缺失，请尽快升级至最新版本！\\\"}",
            "Mute": false,
            "NoticeFeature": true,
            "RiskNameEn": "Low engine version",
            "SuggestionEn": "Upgrade to the latest version",
            "SituationEn": "The current engine version is low, and there are many missing features",
            "DescriptionEn": "Upgrade to the latest version to ensure that all features are available!"
          }
        ],
        "ChargeType": "PREPAY"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.