DescribeParameters - Tair (Redis® OSS-Compatible) - Centro de documentación de Alibaba Cloud

Consulta los parámetros de configuración y los parámetros de ejecución de una instancia de Tair (compatible con Redis® OSS).

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

kvstore:DescribeParameters

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región. Puede llamar a DescribeRegions para consultar las regiones disponibles. Utilice este parámetro para especificar la región de la instancia.	cn-hangzhou
DBInstanceId	string	Sí	El ID de la instancia.	r-bp1zxszhcgatnx****
NodeId	string	No	El ID del nodo. Nota Especifique este parámetro para consultar la configuración de parámetros de un nodo específico en una instancia de clúster.	r-bp1xxxxxxxxxxxxx-db-0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El objeto de respuesta.
RequestId	string	El ID de la solicitud.	9C1338BE-8DE8-4890-A900-E1BC06BF****
Engine	string	El tipo de base de datos.	redis
EngineVersion	string	La versión del motor de base de datos.	4.0
ConfigParameters	object
Parameter	array<object>	La lista de parámetros de configuración que aún no han surtido efecto.
	object	El objeto.
CheckingCode	string	El código de verificación que indica los valores válidos del parámetro.	[0\|1]
ParameterName	string	El nombre del parámetro.	script_check_enable
ParameterValue	string	El valor del parámetro.	1
ForceRestart	boolean	Indica si es necesario reiniciar para que el parámetro surta efecto. Valores válidos: True: Es necesario reiniciar. False: No es necesario reiniciar. El parámetro surte efecto inmediatamente después de enviarse.	true
ParameterDescription	string	La descripción del parámetro.	Check all keys passed in the KEYS array map to the same slot
ModifiableStatus	boolean	Indica si el parámetro se puede modificar. Valores válidos: False: El parámetro no se puede modificar. True: El parámetro se puede modificar.	true
RunningParameters	object
Parameter	array<object>	La lista de parámetros de ejecución.
	object	El objeto.
CheckingCode	string	Los valores válidos del parámetro.	[0\|1]
ParameterName	string	El nombre del parámetro.	#no_loose_disabled-commands
ParameterValue	string	El valor del parámetro.	keys,flushall,flushdb
ForceRestart	string	Indica si es necesario reiniciar para que el parámetro surta efecto. Valores válidos: True: Es necesario reiniciar. False: No es necesario reiniciar. El parámetro surte efecto inmediatamente después de enviarse.	true
ParameterDescription	string	La descripción del parámetro.	You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script]
ModifiableStatus	string	Indica si el parámetro se puede modificar. Valores válidos: False: El parámetro no se puede modificar. True: El parámetro se puede modificar.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "9C1338BE-8DE8-4890-A900-E1BC06BF****",
  "Engine": "redis",
  "EngineVersion": "4.0",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "script_check_enable",
        "ParameterValue": "1",
        "ForceRestart": true,
        "ParameterDescription": "Check all keys passed in the KEYS array map to the same slot.",
        "ModifiableStatus": true
      }
    ]
  },
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "#no_loose_disabled-commands",
        "ParameterValue": "keys,flushall,flushdb",
        "ForceRestart": "true",
        "ParameterDescription": "You can disable some dangerous commands, for example \\\"keys,flushdb,flushall\\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
        "ModifiableStatus": "true"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.

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.