• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Heat
  5. Stack Resources
  6. Mark a Resource as Unhealthy

Mark a Resource as Unhealthy

Function Description

This interface is used to nark the status of a specified resource as unhealthy.

Interface Format

Method

URI

Description

PATCH

/v1/{tenant_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name_or_physical_id}

Marks the status of a specified resource.

Request Parameter

Parameter

Type

Mandatory

Description

tenant_id

String

Yes

Specifies the tenant ID.

stack_name

String

Yes

Specifies the stack name. The value must meet the regular expression rule (^[a-zA-Z][a-zA-Z0-9_.-]{0,254}$).

stack_id

String

Yes

Specifies the stack ID.

resource_name_or_physical_id

String

Yes

Specifies the resource name.

mark_unhealthy

Bool

Yes

Specifies whether to mark the status of a resource to unhealthy.

resource_status_reason

String

No

Describes the cause of the current resource status.

Response Parameter

N/A

Request Example

PATCH /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/65eb0ae7-36de-4104-aace-6bd040a2f95f/resources/my_instance
{
    "mark_unhealthy": false,
    "resource_status_reason": "test reset"
}

Response Example

None

Returned Code

For details, see section Return Code Processing.