DescribeSDGs - ENS - Centro de documentación de Alibaba Cloud

Consulta información sobre los grupos de datos compartidos (SDG) creados.

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

ens:DescribeSDGs

none

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
SDGIds	array	No	La lista de los ID de SDG que se van a consultar.
	string	No	El ID del SDG que se va a consultar. Si este parámetro se deja vacío, se consultan todos los SDG.	["sdg-1", "sdg-2", "sdg-3"]
InstanceIds	array	No	La lista de los ID de instancias de AIC que se van a consultar.
	string	No	El ID de la instancia de AIC que se va a consultar. Si este parámetro se deja vacío, se consultan todas las instancias. Nota Si se especifican tanto SDGIds como InstanceIds, los resultados de la consulta son la intersección de ambas condiciones.	["aic-1", "aic-2", "aic-3"]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	3703C4AC-9396-458C-8F25-1D701334D309
SDGs	array<object>	La lista de información de los SDG.
	array<object>	La lista de información de los SDG.
AvaliableRegionIds	array<object>	La lista de zonas de borde disponibles.
	object	La lista de zonas de borde disponibles.
CreationTime	string	La hora de creación del SDG en la zona de borde.	2023-02-27 15:13:26
RegionId	string	El ID de la zona de borde.	cn-hangzhou-26
SnapshotId	string	El ID de la instantánea.	mock-clone_snapshot_id
Status	string	El estado del SDG en la zona de borde. Valores válidos: sdg_making: En creación. sdg_saving: En proceso de guardado. sdg_copying: En sincronización entre zonas de borde. failed: Creación fallida. success: Creación correcta.	success
CreationDiskType	string	El tipo del disco de origen que se utilizó para crear el SDG.	standard
CreationRegionId	string	El ID de la zona de borde donde se creó el SDG.	cn-hangzhou-26
CreationTime	string	La hora en que se creó el SDG por primera vez.	2023-02-27 15:07:21
DeployedInstanceIds	array<object>	La lista de información del estado de despliegue.
	object	La lista de información del estado de despliegue.
CreationTime	string	La hora en que se desplegó el SDG en la instancia.	2023-02-27 16:48:43
InstanceId	string	El ID de la instancia de AIC.	aic-5x20dyeos****
Status	string	El estado de despliegue. Valores válidos: sdg_deploying: En despliegue. failed: Despliegue fallido. success: Despliegue correcto.	sdg_deploying
DeploymentType	string	El tipo de despliegue del SDG. Valores válidos: common: despliegue estándar overlay: despliegue con separación de lectura/escritura	overlay
Description	string	La descripción del SDG.	SDG de prueba
ParentSDGId	string	El ID del SDG de origen que se utilizó para la creación incremental. Corresponde al parámetro FromSDGId especificado al llamar a CreateSDG.	sdg-xxxxx
SDGId	string	El ID del SDG.	sdg-30e1fdba7196bc****
Size	integer	El tamaño del SDG. Unidad: GB.	20
Status	string	El estado de creación del SDG. Valores válidos: sdg_making: En creación. sdg_saving: En proceso de guardado. failed: Creación fallida. success: Creación correcta.	success
UpdateTime	string	La hora en que se actualizó el SDG por última vez.	2023-02-27 16:04:39
CreationInstanceId	string	El ID de la instancia que se utilizó para crear el SDG.	aic-5x20dyeos****
BillingType	string	El tipo de facturación.	Open
PerformanceLevel	integer	La proporción de uso compartido del SDG.	100
BillingCycle	string	El ciclo de facturación del disco compartido.	Hour

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "3703C4AC-9396-458C-8F25-1D701334D309",
  "SDGs": [
    {
      "AvaliableRegionIds": [
        {
          "CreationTime": "2023-02-27 15:13:26",
          "RegionId": "cn-hangzhou-26",
          "SnapshotId": "mock-clone_snapshot_id",
          "Status": "success"
        }
      ],
      "CreationDiskType": "standard",
      "CreationRegionId": "cn-hangzhou-26",
      "CreationTime": "2023-02-27 15:07:21",
      "DeployedInstanceIds": [
        {
          "CreationTime": "2023-02-27 16:48:43",
          "InstanceId": "aic-5x20dyeos****",
          "Status": "sdg_deploying",
          "DeploymentType": "overlay"
        }
      ],
      "Description": "测试SDG",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39",
      "CreationInstanceId": "aic-5x20dyeos****",
      "BillingType": "Open",
      "PerformanceLevel": 100,
      "BillingCycle": "Hour"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Interface.Call.Failed	%s.
400	Parameter.Invalid	The parameter is invalid. Please check your parameters and try it again.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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.