UpdateInstance - OpenSearch - Centro de documentación de Alibaba Cloud

Descripción de la operación

Método

PUT

URI

/openapi/ha3/instances/{instanceId}

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

searchengine:UpdateInstance

update

*Instance.

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

Ninguna

Sintaxis de la solicitud

PUT /openapi/ha3/instances/{instanceId} HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
instanceId	string	No	El ID de la instancia.	ha-cn-pl32rf0****

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	El cuerpo de la solicitud.	{}
components	array<object>	No	La lista de especificaciones de la instancia. No puede actualizar este parámetro junto con description.
	object	No	La especificación de la instancia.
code	string	No	El código de especificación, que debe ser coherente con los parámetros de venta.	searcherdocsizesum
value	string	No	El valor.	200
orderType	string	No	Valores válidos: UPGRAGE: Aumenta las especificaciones de la instancia. DOWNGRADE: Reduce las especificaciones de la instancia. No puede especificar este parámetro junto con description.	UPGRAGE
description	string	No	La descripción de la instancia. No puede actualizar este parámetro junto con components u orderType.	Instance description

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
result	object	El resultado devuelto.
description	string	La descripción de la instancia.	Test instance
resourceGroupId	string	El ID del grupo de recursos.	ha-cn-pl32rf0****
expiredTime	string	La hora de vencimiento en el formato AAAA-MM-DDTHH:mm:ss.S.	2019-01-06T16:00:00.0
commodityCode	string	El código de producto.	opensearch_ha3post_public_cn
status	string	El estado.	READY
instanceId	string	El ID del recurso principal.	ha-cn-pl32rf0****
createTime	string	La hora de creación en el formato AAAA-MM-DDTHH:mm:ss.S.	2018-12-06T11:17:49.0
lockMode	string	El estado de bloqueo.	Unlock
chargeType	string	El método de facturación.	POSTPAY
updateTime	string	La hora de actualización en el formato AAAA-MM-DDTHH:mm:ss.S.	2018-12-06T11:17:49.0
inDebt	boolean	Indica si la instancia tiene un pago vencido.	false
requestId	string	El ID de la solicitud.	90D6B8F5-FE97-4509-9AAB-367836C51818

Ejemplos

Respuesta exitosa

JSON Formato

{
  "result": {
    "description": "Test instance",
    "resourceGroupId": "ha-cn-pl32rf0****",
    "expiredTime": "2019-01-06T16:00:00.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "status": "READY",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2018-12-06T11:17:49.0",
    "lockMode": "Unlock",
    "chargeType": "POSTPAY",
    "updateTime": "2018-12-06T11:17:49.0",
    "inDebt": false
  },
  "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}

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.