DescribeInstanceAutoRenewalAttribute - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Consulta el estado de renovación automática de instancias de MongoDB.

Descripción de la operación

Esta operación es aplicable a instancias de suscripción.

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

dds:DescribeInstanceAutoRenewalAttribute

get

Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la instancia. Puede llamar a la operación DescribeDBInstanceAttribute para consultar el ID de la región de la instancia.	cn-hangzhou
DBInstanceId	string	No	El ID de la instancia.	dds-bp567b****
DBInstanceType	string	No	La categoría de la instancia. Valores válidos: replicate: la instancia independiente o de conjunto de réplicas sharding: la instancia de clúster fragmentado Valor predeterminado: replicate.	replicate
PageSize	integer	No	El número de entradas que se devolverán en cada página. Valores válidos: 30, 50 y 100. Nota Valor predeterminado: 30.	30
PageNumber	integer	No	El número de la página que se devolverá. El valor debe ser un entero positivo que no exceda el valor máximo del parámetro Integer. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
ItemsNumbers	integer	El número total de entradas devueltas.	2
PageRecordCount	integer	El número de entradas que se devolvieron en la página actual.	2
RequestId	string	El ID de la solicitud.	FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949
PageNumber	integer	El número de página de la página devuelta.	1
Items	object
Item	array<object>	Detalles sobre las entradas devueltas.
	object
DBInstanceType	string	La categoría de la instancia. Valores válidos: replicate: la instancia independiente o de conjunto de réplicas sharding: la instancia de clúster fragmentado	replicate
AutoRenew	string	Indica si la renovación automática está habilitada para la instancia. Valores válidos: true: La renovación automática está habilitada para la instancia. false: La renovación automática está deshabilitada para la instancia.	true
Duration	string	El período de renovación automática. Unidad: meses. Nota Este parámetro se devuelve solo cuando el valor devuelto del parámetro AutoRenew es true. Puede llamar a la operación ModifyInstanceAutoRenewalAttribute para modificar el período de renovación automática.	1
DbInstanceId	string	El ID de la instancia.	dds-bp2568*****
RegionId	string	El ID de la región de la instancia.	cn-hangzhou

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ItemsNumbers": 2,
  "PageRecordCount": 2,
  "RequestId": "FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949",
  "PageNumber": 1,
  "Items": {
    "Item": [
      {
        "DBInstanceType": "replicate",
        "AutoRenew": "true",
        "Duration": "1",
        "DbInstanceId": "dds-bp2568*****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred. Please try again later.

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.