Todos los productos
Search
Centro de documentos

ApsaraMQ for RocketMQ:OnsInstanceUpdate

Última actualización: Sep 01, 2026

Llama a la operación OnsInstanceUpdate para actualizar el nombre y la descripción de una instancia.

Descripción de la operación

Importante

La OpenAPI proporcionada por Alibaba Cloud es una API de gestión. Puede utilizar esta API para gestionar y consultar recursos de los servicios de Alibaba Cloud. Integre la OpenAPI únicamente con fines de gestión. No utilice la OpenAPI para enlaces de datos principales que envíen o reciban mensajes. Esto ayuda a prevenir posibles amenazas a sus enlaces de datos.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

  • Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.

  • API: La API que debe invocarse para llevar a cabo la acción.

  • Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.

  • Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.

    • En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.

    • Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.

  • Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.

  • Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

mq:UpdateInstance

*Instance

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

Ninguna
  • mq:QueryInstanceBaseInfo

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Remark

string

No

La descripción actualizada de la instancia. Si deja este parámetro vacío, la descripción no se actualiza.

Actualización de notas

InstanceName

string

No

El nombre actualizado de la instancia. El nombre debe cumplir los siguientes requisitos:

  • El nombre de la instancia debe ser único en la región donde está desplegada la instancia.

  • El nombre debe tener entre 3 y 64 caracteres de longitud y puede contener caracteres chinos, letras, dígitos, guiones (-) y guiones bajos (_).

  • Si deja este parámetro vacío, el nombre no se actualiza.

Actualización de nombre

InstanceId

string

Sí

El ID de la instancia cuyo nombre o descripción desea actualizar.

MQ_INST_188077086902****_BXSuW61e

Elementos de la respuesta

Elemento

Tipo

Descripción

Ejemplo

object

RequestId

string

El ID de la solicitud. Este ID es único para cada solicitud. Utilice este ID para localizar y solucionar problemas.

A07E3902-B92E-44A6-B6C5-6AA111111****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.