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

Descripción de la operación

Sintaxis de la solicitud

PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config

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:ModifyClusterOfflineConfig

update

*Instance

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

Ninguna

Sintaxis de la solicitud

PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
instanceId	string	Sí	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.	{}
dataSourceName	string	No	El nombre del origen de datos.	ha-cn-pl32rf0****_test_api
dataSourceType	string	No	El tipo de origen de datos. Valores válidos: odps: MaxCompute. swift: Swift. unKnow: tipo desconocido.	odps
domain	string	No	El centro de datos en el que se despliega el origen de datos.	vpc_hz_domain_1
config	object	No	El nombre de la configuración, que se almacena como clave.
	integer	No	La versión de la configuración, que se almacena como valor.	1
partition	string	No	Este parámetro es obligatorio cuando se activa la compilación de índices para datos completos en un origen de datos de MaxCompute.	ds=20211202
dataTimeSec	integer	No	La marca de tiempo de los datos, en segundos. Este parámetro es obligatorio cuando un origen de datos enviado mediante API activa una compilación de índice completa.	1640867288
buildMode	string	No	El método de reindexación. Valores válidos: api: origen de datos de API. indexRecover: recuperación de datos mediante indexación.	indexRecover
generation	integer	No	El ID de la versión completa del índice.	160142641
pushMode	string	No	El modo de envío de la configuración. De forma predeterminada, solo se envía la configuración.	PUSH_ONLY

Parámetro	Obligatorio	Tipo	Descripción
dataSource	Sí	String	El nombre del origen de datos.
domain	Sí	String	El dominio donde se despliega el origen de datos.
indexes	Sí	Object	La descripción de la estructura del índice.
advancedConfigVersionId	Sí	Integer	El ID de la versión de configuración avanzada.
triggerBuild	Sí	boolean	Si este parámetro se establece en true, se envía la configuración y se activa la reindexación. Si este parámetro se establece en false, la configuración surte efecto después de la siguiente reindexación.
buildMode	No	Integer	El modo de reindexación. api indica el modo predeterminado, e indexRecover indica que el origen de datos se restaura mediante el índice. Este parámetro solo es obligatorio cuando el origen de datos es del tipo HDFS.
generation	No	Long	La versión de restauración de datos.
partition	No	String	La partición de datos del origen de datos seleccionada para la reindexación. Este parámetro es obligatorio cuando se activa la reindexación para el origen de datos odps.
dataTimeSec	No	Integer	La marca de tiempo de los datos para reindexar un origen de datos enviado mediante API, en segundos. Este parámetro es obligatorio cuando se activa la reindexación para el origen de datos enviado mediante API.
dataSourceType	No	Enum	Este parámetro es obligatorio cuando el parámetro triggerBuild se establece en true. Valores válidos: odps y swift.

Solicitudes de ejemplo

PUT /openapi/ha3/instances/ha3_instance_name/cluster-offline-config

{
    "dataSource": "test1",
    "domain": "xx",
    "indexes": [
        {
            "name": "index1",
            "versionId": 1
        },
        {
            "name": "index2",
            "versionId": 1
        }
    ],
    "advancedConfigVersionId": 2,
    "triggerBuild": true,
    "partition": "20201010", // Este parámetro es obligatorio cuando se activa la reindexación para el origen de datos odps.
    "dataSourceType": "odps", // Este parámetro es obligatorio. Establezca este parámetro en odps o swift. Se devuelve un mensaje de error si no establece este parámetro.
    "dataTimeSec": 1640867288 // Este parámetro especifica la hora en que se activa la reindexación para el origen de datos enviado mediante API. El valor de este parámetro debe ser preciso hasta el segundo. Este parámetro es obligatorio cuando se activa la reindexación para el origen de datos enviado mediante API.
  
}

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de respuesta.
requestId	string	El ID de la solicitud.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	El resultado.	{}

Ejemplo de respuesta

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

Para obtener más detalles, consulte Estructura de la respuesta

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {}
}

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.