Aprenda a depurar operaciones de API de Alibaba Cloud en línea mediante OpenAPI Explorer.
Cree una cuenta de Alibaba Cloud
Las llamadas a la API requieren una cuenta de Alibaba Cloud. Si no tiene una, regístrese en el sitio web oficial de Alibaba Cloud.
Activar servicios de Alibaba Cloud
Active los servicios de Alibaba Cloud que desee usar. A continuación se muestra un ejemplo con SMS:
Vaya a User Center, busque Short Message Service y haga clic en Activate.
Vaya a la consola del servicio, por ejemplo, la consola de SMS, y haga clic en Activate.
Debe activar un servicio de Alibaba Cloud antes de llamar a sus operaciones de API.
Depurar una operación de API en línea
Inicie sesión en OpenAPI Explorer, seleccione un servicio de Alibaba Cloud activado, como ECS, y luego haga clic en Debug.
Seleccione la operación de API que desea depurar, por ejemplo, DescribeInstanceTypeFamilies para ECS. En la sección Parameters, introduzca los valores tal como se indica en la pestaña Document y, a continuación, haga clic en Initiate Call. OpenAPI online debugging.
Respuesta
La pestaña Response muestra el HTTP status code y los datos que devuelve la llamada.
Esta pestaña también muestra la información de Request Header y Response Header.
Llamada exitosa
Una llamada exitosa devuelve el código de estado HTTP 200 junto con una respuesta JSON. Cada parámetro se describe en la documentación de la API, como en la referencia de DescribeInstanceTypeFamilies.
Llamada con errores
Una llamada con errores devuelve un código de estado HTTP en el rango 4xx. Las API de Alibaba Cloud usan una estructura de respuesta de error unificada, salvo algunos servicios que no usan la puerta de enlace estándar. A continuación se muestra el formato de error de la operación RunInstances de ECS:
{
"RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Message": "The specified endpoint cant operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.(from POP)",
"Recommend": "https://api.alibabacloud.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs&requestId=7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"HostId": "ecs-cn-hangzhou.aliyuncs.com",
"Code": "InvalidOperation.NotSupportedEndpoint"
}|
Parámetro |
Descripción |
|
RequestId |
Identificador de solicitud único globalmente. Proporcione este |
|
HostId |
Endpoint del servicio donde ocurrió el error. En este ejemplo, corresponde al endpoint de ECS en la región China (Hangzhou). |
|
Code |
Identificador corto del tipo de error. Consulte este código en la documentación de Alibaba Cloud para encontrar soluciones. En este ejemplo, el endpoint no admite la región de destino. |
|
Message |
Mensaje detallado del error. En este ejemplo, el endpoint no es compatible con la región seleccionada. Use la API |
|
Recommend |
URL de diagnóstico. Abra este enlace para visitar OpenAPI Troubleshoot y consultar posibles soluciones. |
Para solucionar errores, use OpenAPI Troubleshoot.
Código de ejemplo del SDK
En la pestaña SDK sample code, seleccione una SDK version y un lenguaje, y luego haga clic en Run Example.
También puede hacer clic en View Version Differences para comparar versiones del SDK, en Download Full Project para descargar el código o bien alternar Generate Example in Common Mode para cambiar el modo de generación.
Ejemplo de CLI
En la pestaña CLI example, haga clic en el botón de ejecución para depurar el comando en línea.
Historial de llamadas
La pestaña Call History enumera sus llamadas de API anteriores. Revise los parámetros y haga clic en Redebug para volver a ejecutar una llamada. Si el status de una llamada aparece con errores, use Diagnose para identificar la causa.
Códigos de error
La pestaña Error Codes muestra los posibles errores y su descripción. Haga clic en Diagnose para abrir la página de diagnóstico, que proporciona documentos relevantes, debates en foros y opciones de soporte.
Por ejemplo, si introduce un RegionId no válido, se devuelve el código de estado HTTP 404, el código de error InvalidRegionId.NotFound y el mensaje The RegionId provided does not exist in our records..