All Products
Search
Document Center

Smart Access Gateway:DeleteHealthCheck

Last Updated:Mar 24, 2026

Deletes a health check instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DeleteHealthCheck

delete

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The ID of the region where the health check instance is deployed.

cn-shanghai

HcInstanceId

string

Yes

The ID of the health check instance.

hc-vfgyz7dv07lthr****

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

7F0B079C-2D0E-4ABF-A970-C079F785A09C

Examples

Success response

JSON format

{
  "RequestId": "7F0B079C-2D0E-4ABF-A970-C079F785A09C"
}

Error codes

HTTP status code

Error code

Error message

Description

400 HC.InstanceNoFound The specified network health check instance does not exist. The specified network health check instance does not exist.
400 HC.RelatedRoute The specified health check instance has associated routes and cannot be deleted. The specified health check instance has associated routes and cannot be deleted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.