All Products
Search
Document Center

Resource Orchestration Service:SignalResource

Last Updated:Sep 12, 2024

Sends a signal to a resource in a stack.

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
ros:SignalResourceupdate
  • stack
    acs:ros:{#regionId}:{#accountId}:stack/{#stackId}
    none
none

Request syntax

POST /V2/SignalResource

GET /V2/SignalResource

Request parameters

ParameterTypeRequiredDescriptionExample
StackIdstringYes

The ID of the stack.

4a6c9851-3b0f-4f5f-b4ca-a14bf691****
StatusstringYes

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
SUCCESS
RegionIdstringYes

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

cn-hangzhou
UniqueIdstringYes

The unique ID of the signal. The ID must be 1 to 64 characters in length. If multiple signals are sent to a single resource, each signal must have a unique ID.

27c7347b-352a-4377-accf-63d361c1****
ClientTokenstringNo

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 be up to 64 characters in length and can contain letters, digits, hyphens (-) and underscores (_).

For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-42665544****
LogicalResourceIdstringYes

The logical ID of the resource as defined in the template.

WebServer

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

B288A0BE-D927-4888-B0F7-B35EF84B6E6

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-08-15The internal configuration of the API is changed, but the call is not affectedView Change Details