Data Management (DMS) ofrece una consola visual y acceso programático mediante la depuración en línea de OpenAPI, el SDK de Alibaba Cloud y la CLI de Alibaba Cloud. Para desarrollar de manera eficiente con DMS, seleccione el método de integración que mejor se adapte a sus requisitos.
Descripción general de OpenAPI
Para facilitar el aprendizaje y uso eficiente de OpenAPI en nuestros productos en la nube, Alibaba Cloud proporciona el sitio web de OpenAPI. Esta plataforma integral incluye búsqueda inteligente, documentación, depuración en línea, acceso a SDK, ejemplos de código, diagnóstico de errores y estadísticas de llamadas. Puede utilizar el portal de OpenAPI para invocar las API de diversos productos de Alibaba Cloud, así como consultar las solicitudes y respuestas. El portal también genera automáticamente ejemplos de código del SDK para ayudarle a comenzar rápidamente con los productos de Alibaba Cloud. Para obtener más información, consulte What is OpenAPI?.
Versiones de la API
Alibaba Cloud OpenAPI utiliza números de versión para gestionar las versiones principales de las API de los productos en la nube.
Por ejemplo, DMS es compatible con la versión de API 2018-11-01. La cadena 2018-11-01 es un identificador de versión de la API, no una fecha. Proporciona acceso a las funciones más recientes de la API y no indica que la API haya permanecido estática desde 2018-11-01.
|
Función |
Versión de la API |
Descripción |
|
Data Management (DMS) |
Recomendado. |
Depuración en línea
DMS ofrece depuración de API y otras funciones en el portal de OpenAPI. Antes de realizar una llamada a la API, debe comprender las versiones, los endpoints, el estilo de la API y los métodos de solicitud que proporciona DMS.
En la página de depuración del portal de OpenAPI, el panel de navegación izquierdo enumera operaciones de API como ListInstances (recupera una lista de información de instancias), AddInstance, ModifyInstance, GetInstance y DeleteInstance. Una vez que selecciona una operación de API, el panel central le permite configurar el endpoint, por ejemplo China (Hangzhou), y los parámetros de la solicitud. Estos parámetros incluyen Tid (ID de inquilino), SearchKey (palabra clave de búsqueda), DbType (tipo de base de datos), EnvType (tipo de entorno), InstanceSource (origen de la instancia), NetType (tipo de red), InstanceState (estado de la instancia) y PageNumber (número de página). Después de ingresar los valores, haga clic en Initiate Call para enviar la solicitud. El panel de documentación a la derecha muestra el tipo de dato y un valor de ejemplo para cada parámetro.
Puntos de entrada para depuración
|
Función |
Versión de la API |
Punto de entrada |
|
Data Management (DMS) |
Endpoints
DMS
Seleccione el endpoint correspondiente a la región donde se encuentran sus recursos para minimizar la latencia.
Por ejemplo, el endpoint de VPC para la región China (Zhangjiakou) es dms-enterprise-vpc.cn-zhangjiakou.aliyuncs.com. Para obtener más información, consulte Endpoints.
Identidades compatibles
Después de iniciar sesión en el sitio web de OpenAPI con su cuenta de Alibaba Cloud, las llamadas a la API se realizan con esta cuenta de forma predeterminada durante la depuración en línea. Usar una cuenta de Alibaba Cloud para el acceso rutinario a la API conlleva un alto riesgo debido a sus permisos completos. Se recomienda encarecidamente crear y utilizar un usuario de RAM para las operaciones diarias. Otorgue permisos al usuario de RAM según sus necesidades empresariales antes de realizar llamadas a la API. El usuario de RAM debe tener los permisos necesarios para operar DMS. Para obtener más información, consulte Use RAM for access control.
|
Identidad de usuario |
Compatible |
|
Compatible |
|
|
RAM user (recomendado) |
Compatible |
|
RAM role (recomendado) |
Compatible |
Métodos de integración
Descripción general de la integración
DMS ofrece varios métodos de integración, incluidos los SDK. Puede elegir el método que mejor se adapte a sus necesidades empresariales.
Los SDK son fáciles de integrar y constituyen el método recomendado para llamar a OpenAPI.
DMS
|
Método |
Compatible |
|
Alibaba Cloud SDK (recomendado) |
Compatible |
|
Compatible |
|
|
Parcialmente compatible |
|
|
No compatible |
|
|
Custom API encapsulation (no recomendado) |
Compatible |
SDK de Alibaba Cloud
Alibaba Cloud proporciona SDK para múltiples lenguajes de programación, incluidos Java, C#, Go, Python, Node.js/TypeScript, PHP y C++. Solo necesita integrar el SDK para llamar a OpenAPI directamente a través de los métodos expuestos. Los SDK simplifican el desarrollo al manejar la lógica de firma, los tiempos de espera y los mecanismos de reintento, además de devolver objetos Response estructurados. Para obtener más información sobre los SDK de Alibaba Cloud, consulte Alibaba Cloud SDK.
Para obtener información sobre los lenguajes y dependencias compatibles con el SDK de DMS, consulte SDK de DMS.
CLI de Alibaba Cloud
La CLI de Alibaba Cloud le permite interactuar con los servicios de Alibaba Cloud y gestionar sus recursos en la nube desde una terminal mediante comandos
aliyun. Para obtener más información sobre la CLI de Alibaba Cloud, consulte What is Alibaba Cloud CLI?Puede usar la CLI de Alibaba Cloud para llamar a operaciones de la API de DMS. Para obtener más información, consulte Call RPC API operations by using Alibaba Cloud CLI.
Resource Orchestration (ROS)
Resource Orchestration Service (ROS) es un servicio de Alibaba Cloud que simplifica la gestión de recursos en la nube. Los desarrolladores y administradores pueden escribir plantillas para definir los recursos requeridos de Alibaba Cloud, como instancias de ECS e instancias de base de datos RDS, junto con sus dependencias. El motor de orquestación de ROS crea y configura automáticamente todos los recursos basándose en la plantilla, lo que habilita el despliegue automatizado y las tareas de O&M. Para obtener más información, consulte What is Resource Orchestration Service?.
-
Puede usar ROS para orquestar recursos de DMS. Se admiten los siguientes recursos de DMS:
ALIYUN::DMS::Instance: Registra una nueva instancia.
ALIYUN::DMS::User: Registra un nuevo usuario.
Para utilizar rápidamente ROS en la orquestación de recursos de DMS, consulte ROS integration example.
Encapsulación personalizada de API
Para realizar llamadas HTTP nativas, debe implementar el algoritmo de firma, construir solicitudes personalizadas e iniciar las llamadas HTTP. Para obtener más información sobre el mecanismo de firma, consulte DMS API overview y Request body and signature mechanism (V3).
Notas de uso
DMS
Si falla una llamada a la API, utilice el código de error devuelto para comprobar los parámetros de su solicitud y sus valores. Para obtener más información, consulte Códigos de error.
Alternativamente, registre el RequestID o el mensaje de error del SDK de la respuesta y utilice Diagnóstico de OpenAPI de Alibaba Cloud para solucionar el problema.