All Products
Search
Document Center

Microservices Engine:PutClusterHealthCheckTask

Last Updated:Feb 20, 2024

Initiates a task to check risk evaluation for an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

The ID of the instance.

mse_prepaid_public_cn-2r42o83h506
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

5B170A0D-2C5D-4CF8-B808-03966B86****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codeinteger

The status code. A value of 200 is returned if the request is successful.

200
ErrorCodestring

The error code returned if the request failed.

mse-100-000
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

  • If the request is successful, a success message is returned.
  • If the request fails, an error message is returned, such as the "TaskId not found" message.
The request is successfully processed.
DynamicCodestring

The dynamic part in the error message.

code
DynamicMessagestring

The dynamic part in the error message. This parameter is used to replace the **%s** variable in the ErrMessage parameter.

Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.
The specified parameter is invalid.
Databoolean

The data returned.

null

Examples

Sample success responses

JSONformat

{
  "RequestId": "5B170A0D-2C5D-4CF8-B808-03966B86****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-25The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.