All Products
Search
Document Center

:OnsTopicUpdate

Last Updated:Aug 28, 2026

Calls the OnsTopicUpdate operation to configure the read and write mode of a topic.

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Operation description

Important The OpenAPI provided by Alibaba Cloud is a management API used to manage and query resources of Alibaba Cloud services. It is only recommended for integration in management scenarios. Do not rely on OpenAPI in the core data path of message sending and receiving. Otherwise, risks may be introduced to the link.
This operation is generally used in scenarios where read or write operations are prohibited.

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

mq:UpdateTopic

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

None
  • mq:OnsInstanceBaseInfo

Request parameters

Parameter

Type

Required

Description

Example

Topic

string

Yes

The name of the topic that you want to configure.

test

Perm

integer

Yes

The read and write mode of the topic. Valid values:

  • 6: Both read and write operations are supported.

  • 4: Write operations are prohibited.

  • 2: Read operations are prohibited.

6

InstanceId

string

No

The ID of the instance to which the topic that you want to configure belongs.

MQ_INST_111111111111_DOxxxxxx

Response elements

Element

Type

Description

Example

object

RequestId

string

The common parameter. Each request has a unique ID that is used to troubleshoot and locate issues.

81979ADA-4A78-4F64-9DEC-5700446D****

Examples

Success response

JSON format

{
  "RequestId": "81979ADA-4A78-4F64-9DEC-5700446D****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.