All Products
Search
Document Center

:OnsTopicUpdate

Last Updated:Dec 05, 2023

Configures the read/write mode for a specified topic.

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 to forbid read or write operations on a specific topic.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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
mq:UpdateTopicWrite
  • Topic
    acs:mq:{#regionId}:{#accountId}:{#TopicName}
  • Topic
    acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TopicstringYes

The name of the topic that you want to manage.

test
PermintegerYes

The read/write mode that you want to configure for the topic. Valid values:

  • 6: Both read and write operations are allowed.
  • 4: Write operations are forbidden.
  • 2: Read operations are forbidden.
6
InstanceIdstringYes

The ID of the instance to which the topic belongs.

MQ_INST_111111111111_DOxxxxxx

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.

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2022-02-22The API operation is deprecated.see changesets
Change itemChange content
API Deprecation DescriptionThe API operation is deprecated.