All Products
Search
Document Center

ApsaraMQ for RocketMQ:OpenOnsService

Last Updated:Mar 03, 2024

Activates ApsaraMQ for RocketMQ.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

You can call this operation the first time you use ApsaraMQ for RocketMQ. You can use ApsaraMQ for RocketMQ only after the service is activated.

The ApsaraMQ for RocketMQ service can be activated only in the China (Hangzhou) region. Service activation is not billed.

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
ons:OpenOnsServiceWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.

8C5B4603-8977-4513-AB60-9C3E2F88****
OrderIdstring

The ID of the order.

2068689****0272

Examples

Sample success responses

JSONformat

{
  "RequestId": "8C5B4603-8977-4513-AB60-9C3E2F88****",
  "OrderId": "2068689****0272"
}

Error codes

HTTP status codeError codeError message
400OrderOpend
400PermissionDenied
400PriceWanHuaTongSys

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

Change history

Change timeSummary of changesOperation
2023-06-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-06-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change

Activate ApsaraMQ for RocketMQ in the console

You can also activate ApsaraMQ for RocketMQ in the console. For more information, see Activate ApsaraMQ for RocketMQ.