You can call this operation to send signals.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SignalResource

The operation that you want to perform. Set the value to SignalResource.

RegionId String Yes cn-hangzhou

The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.

StackId String Yes 4a6c9851-3b0f-4f5f-b4ca-a14bf691f2ff

The ID of the stack.

LogicalResourceId String Yes WebServer

The logical resource ID defined in the template.

Status String Yes SUCCESS

The status of the signal. Failure signals can cause stack creation or update to fail. If all signals are warnings, the stack cannot be created or updated. Valid values:

  • SUCCESS
  • FAILURE
  • WARNING
UniqueId String Yes 27c7347b-352a-4377-accf-63d361c1ea60

The unique ID of the signal. If multiple signals are sent to a single resource, each signal must have a unique ID.

The signal must be 1 to 64 characters in length.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

Response parameters

Parameter Type Example Description
RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6

The ID of the request.

Examples

Sample requests


http(s)://ros.aliyuncs.com/? Action=SignalResource
&RegionId=cn-hangzhou
&StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691f2ff
&LogicalResourceId=WebServer
&Status=SUCCESS
&UniqueId=27c7347b-352a-4377-accf-63d361c1ea60
&<Common request parameters>

Sample success responses

XML format

<SignalResourceResponse>
      <RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId> 
</SignalResourceResponse>

JSON format

{
	"RequestId":"B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}

Error codes

For a list of error codes, visit the API Error Center.

For more information about errors common to all operations, see Common errors.

Error code

Error message

HTTP status code

Description

ResourceNotAvailable

The Resource ({name}) is not available.

404

The error message returned because the specified resource is unavailable. name indicates the resource name.

ResourceNotFound

The Resource ({name}) could not be found in Stack {stack}.

404

The error message returned because the specified resource does not exist in the stack. name indicates the resource name, and stack indicates the name or ID of the stack.

StackNotFound

The Stack ({name}) could not be found.

404

The error message returned because the specified stack does not exist. name indicates the name or ID of the stack.