All Products
Search
Document Center

CloudMonitor:DescribeUnhealthyHostAvailability

Last Updated:Jul 26, 2024

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cms:DescribeUnhealthyHostAvailabilityget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdarrayYes
longYes

The ID of the availability monitoring task. Valid values of N: 1 to 20.

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code.

Note The status code 200 indicates that the call was successful.
200
Messagestring

The returned message.

User not authorized to operate on the specified resource.
RequestIdstring

The ID of the request.

ACBDBB40-DFB6-4F4C-8957-51FFB233969C
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
true
UnhealthyListarray<object>

The unhealthy instances that are detected by the specified availability monitoring tasks.

object
Idlong

The ID of the availability monitoring task.

123456
InstanceListarray

The unhealthy instances that are detected by the availability monitoring task.

string
i-a34b581****

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "ACBDBB40-DFB6-4F4C-8957-51FFB233969C",
  "Success": true,
  "UnhealthyList": {
    "NodeTaskInstance": [
      {
        "Id": 123456,
        "InstanceList": {
          "String": [
            "i-a34b581****"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
500InternalErrorThe request processing has failed due to some unknown error.-

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

Change history

Change timeSummary of changesOperation
No change history