GetDataServicePublishedApi - DataWorks - Centro de documentación de Alibaba Cloud

Obtiene los detalles de una API de DataService Studio publicada.

Descripción de la operación

前置条件：请先开通 DataWorks 企业版或旗舰版，并准备已发布的数据服务 API。ProjectId 可通过 ListProjects 获取，ApiId 可通过 ListDataServicePublishedApis 的 Data.Apis[].ApiId 获取；未开通所需版本时会返回 403 Forbidden.Access。

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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del espacio de trabajo.	10002
TenantId	integer	No	El ID del inquilino. Para obtener el ID del inquilino, siga estos pasos: Inicie sesión en la consola de DataWorks. Busque su espacio de trabajo y vaya a la página de Data Studio. En la página de Data Studio, en la esquina superior derecha, haga clic en el nombre de usuario con el que inició sesión y, a continuación, haga clic en Información del usuario en la sección Menú.	10003
ApiId	integer	Sí	El ID de la API.	10001

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
HttpStatusCode	integer	El código de estado HTTP devuelto.	200
RequestId	string	El ID de la solicitud.	0000-ABCD-EFG****
ErrorMessage	string	El mensaje de error devuelto.	The connection does not exist.
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorCode	string	El código de error devuelto.	Invalid.Tenant.ConnectionNotExists
Data	object	La información más reciente sobre el estado de publicación de la API.
Timeout	integer	El tiempo de espera de la solicitud de la API. Unidad: milisegundos.	10000
Status	integer	El estado de la API. Valores válidos: 0 y 1. El valor 0 indica que la API no está publicada. El valor 1 indica que la API está publicada.	1
ApiId	integer	El ID de la API de DataService Studio.	10000
ApiMode	integer	El tipo de la API. Valores válidos: 0, 1 y 2. El valor 0 indica que la API se genera en modo asistente. El valor 1 indica que la API se genera en modo script. El valor 2 indica que la API se genera mediante registro.	0
ProjectId	integer	El ID del espacio de trabajo.	10001
ResponseContentType	integer	El formato en el que se devuelve la respuesta de la solicitud de la API. Valores válidos: 0 y 1. El valor 0 indica el formato JSON. El valor 1 indica el formato XML. Las API generadas en modo asistente o script admiten el formato JSON. Las API generadas mediante registro admiten los formatos JSON y XML.	0
CreatorId	string	El ID de la cuenta de Alibaba Cloud utilizada por el creador de la API.	1234567
VisibleRange	integer	El ámbito en el que la API es visible. Valores válidos: 0 y 1. El valor 0 indica que la API es visible para los miembros de un espacio de trabajo específico. El valor 1 indica que la API es visible solo para el creador de la API.	0
ModifiedTime	string	La hora en la que se modificó la API por última vez.	2020-06-23T00:21:01+0800
OperatorId	string	El ID de la cuenta de Alibaba Cloud utilizada por el usuario que modificó la API por última vez.	2345678
GroupId	string	El ID del grupo.	ab12**
Description	string	La descripción.	Test API description
RequestMethod	integer	El método de solicitud de la API. Valores válidos: 0, 1, 2 y 3. El valor 0 indica el método GET, el valor 1 indica el método POST, el valor 2 indica el método PUT y el valor 3 indica el método DELETE. Las API generadas en modo asistente o script admiten los métodos GET y POST. Las API generadas mediante registro admiten los métodos GET, POST, PUT y DELETE.	0
CreatedTime	string	La hora de creación.	2020-06-23T00:21:01+0800
ApiName	string	El nombre de la API.	Test API name
TenantId	integer	El ID del inquilino.	10001
ApiPath	string	La ruta de la API.	/test/1
Protocols	array	Los protocolos utilizados por la API. Valores válidos: 0 y 1. El valor 0 indica HTTP. El valor 1 indica HTTPS. Varios protocolos se presentan en una lista.
	integer	El protocolo utilizado por la API. Valores válidos: 0 y 1. El valor 0 indica que la API usa HTTP. El valor 1 indica que la API usa HTTPS. Varios protocolos se presentan en una lista.	0
RegistrationDetails	object	Los detalles de la API registrada. Solo se devuelven para las API registradas.
ServiceHost	string	La URL del servicio backend.	http://www.abc.com
ServiceContentType	integer	El formato en el que se devuelve la respuesta de la solicitud de la API. Valores válidos: 0 y 1. El valor 0 indica el formato JSON. El valor 1 indica el formato XML. Las API generadas en modo asistente o script admiten el formato JSON. Las API generadas mediante registro admiten los formatos JSON y XML.	0
ServicePath	string	La ruta del servicio backend.	/index
SuccessfulResultSample	string	La respuesta de ejemplo correcta de la API.	{"success": true}
FailedResultSample	string	La respuesta de ejemplo de error de la API.	{"success": false}
ServiceRequestBodyDescription	string	La descripción del cuerpo de la solicitud iniciada para llamar al servicio backend.	{"abc":1}
RegistrationErrorCodes	array<object>	La lista de códigos de error de la API registrada.
	object
ErrorMessage	string	El mensaje de error.	The connection does not exist.
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
ErrorSolution	string	La solución.	retry
RegistrationRequestParameters	array<object>	La lista de parámetros de solicitud de la API registrada.
	object	El resultado devuelto.
ParameterName	string	El nombre del parámetro.	name1
ParameterPosition	integer	La posición del parámetro. Valores válidos: 0, 1, 2 y 3. El valor 0 indica que el parámetro está en la ruta URL de la solicitud. El valor 1 indica que el parámetro está en el parámetro Query de la URL de la solicitud. El valor 2 indica que el parámetro está en el encabezado de la solicitud. El valor 3 indica que el parámetro está en el cuerpo de la solicitud. Las API generadas en modo asistente o script solo admiten la posición Query. Las API generadas mediante registro cuyo método de solicitud es GET o DELETE admiten las posiciones Query y Head. Las API generadas mediante registro cuyo método de solicitud es PUT o POST admiten las posiciones Query, Head y Body.	0
ParameterDescription	string	La descripción.	description1
DefaultValue	string	El valor predeterminado.	default1
ParameterOperator	integer	El operador utilizado para el valor del parámetro. Valores válidos: 0, 1, 2 y 3. El valor 0 indica el operador Equal. El valor 1 indica el operador Like. El valor 2 indica el operador Const. El valor 3 indica el operador In. Las API generadas en modo asistente admiten los operadores Equal, Like y In. Las API generadas en modo script admiten el operador Equal. Las API generadas mediante registro admiten los operadores Equal y Const.	0
ExampleValue	string	El valor de ejemplo.	example1
ParameterDataType	integer	El tipo de datos del parámetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
IsRequiredParameter	boolean	Indica si el parámetro es obligatorio.	true
ScriptDetails	object	Los detalles de la API generada en modo script. Este parámetro solo se devuelve si la API se genera en modo script.
IsPagedResponse	boolean	Indica si las entradas se devuelven paginadas.	true
SuccessfulResultSample	string	La respuesta de ejemplo correcta de la API.	{"success": true}
FailedResultSample	string	La respuesta de ejemplo de error de la API.	{"success": false}
Script	string	El script SQL.	select a from t
ScriptErrorCodes	array<object>	Los códigos de error devueltos para la API generada en modo script.
	object	El resultado devuelto.
ErrorMessage	string	El mensaje de error.	fail to call
ErrorCode	string	El código de error.	1001
ErrorSolution	string	La solución utilizada para corregir el error.	retry
ScriptRequestParameters	array<object>	Los parámetros de solicitud de la API generada en modo script.
	object	El resultado devuelto.
ParameterName	string	El nombre del parámetro.	param1
ParameterPosition	integer	La posición del parámetro. Valores válidos: 0: indica que el parámetro está en la ruta URL de la solicitud. 1: indica que el parámetro está en el parámetro Query de la URL de la solicitud. 2: indica que el parámetro está en el encabezado de la solicitud. 3: indica que el parámetro está en el cuerpo de la solicitud. Las API generadas en modo asistente o script solo admiten la posición Query. Las API generadas mediante registro cuyo método de solicitud es GET o DELETE admiten las posiciones Query y Head. Las API generadas mediante registro cuyo método de solicitud es PUT o POST admiten las posiciones Query, Head y Body.	0
ParameterDescription	string	La descripción.	description1
DefaultValue	string	El valor predeterminado.	default1
ParameterOperator	integer	El operador utilizado para el valor del parámetro. Valores válidos: 0: Equal 1: Like 2: Const 3: In Las API generadas en modo asistente admiten los operadores Equal, Like y In. Las API generadas en modo script admiten el operador Equal. Las API generadas mediante registro admiten los operadores Equal y Const.	0
ExampleValue	string	El valor de ejemplo.	example1
ParameterDataType	integer	El tipo de datos del parámetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
IsRequiredParameter	boolean	Indica si el parámetro es obligatorio.	true
ScriptResponseParameters	array<object>	Los parámetros de respuesta de la API generada en modo script.
	object	El resultado devuelto.
ParameterDescription	string	La descripción.	description2
ParameterName	string	El nombre del parámetro.	param2
ExampleValue	string	El valor de ejemplo.	example2
ParameterDataType	integer	El tipo de datos del parámetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
ScriptConnection	object	La información del origen de datos de la API generada en modo script.
TableName	string	El nombre de la tabla en el origen de datos.	t
ConnectionId	integer	El ID del origen de datos.	123
WizardDetails	object	Los detalles de la API generada en modo asistente. Este parámetro solo se devuelve si la API se genera en modo asistente.
IsPagedResponse	boolean	Indica si las entradas se devuelven paginadas.	true
SuccessfulResultSample	string	La respuesta de ejemplo correcta de la API.	{"success": true}
FailedResultSample	string	La respuesta de ejemplo de error de la API.	{"success": false}
WizardErrorCodes	array<object>	Los códigos de error devueltos para la API generada en modo asistente.
	object	El resultado devuelto.
ErrorMessage	string	El mensaje de error.	fail to call
ErrorCode	string	El código de error.	1001
ErrorSolution	string	La solución utilizada para corregir el error.	retry
WizardRequestParameters	array<object>	Los parámetros de solicitud de la API generada en modo asistente.
	object	El resultado devuelto.
ParameterName	string	El nombre del parámetro.	param1
ParameterPosition	integer	La posición del parámetro. Valores válidos: 0, 1, 2 y 3. El valor 0 indica que el parámetro está en la ruta URL de la solicitud. El valor 1 indica que el parámetro está en el parámetro Query de la URL de la solicitud. El valor 2 indica que el parámetro está en el encabezado de la solicitud. El valor 3 indica que el parámetro está en el cuerpo de la solicitud. Las API generadas en modo asistente o script solo admiten la posición Query. Las API generadas mediante registro cuyo método de solicitud es GET o DELETE admiten las posiciones Query y Head. Las API generadas mediante registro cuyo método de solicitud es PUT o POST admiten las posiciones Query, Head y Body.	0
ParameterDescription	string	La descripción.	description1
DefaultValue	string	El valor predeterminado.	default1
ParameterOperator	integer	El operador utilizado para el valor del parámetro. Valores válidos: 0, 1, 2 y 3. El valor 0 indica el operador Equal. El valor 1 indica el operador Like. El valor 2 indica el operador Const. El valor 3 indica el operador In. Las API generadas en modo asistente admiten los operadores Equal, Like y In. Las API generadas en modo script admiten el operador Equal. Las API generadas mediante registro admiten los operadores Equal y Const.	0
ExampleValue	string	El valor de ejemplo.	example1
ParameterDataType	integer	El tipo de datos del parámetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
IsRequiredParameter	boolean	Indica si el parámetro es obligatorio.	true
WizardResponseParameters	array<object>	Los parámetros de respuesta de la API generada en modo asistente.
	object	La lista de parámetros de respuesta en modo asistente.
ParameterDescription	string	La descripción.	description2
ParameterName	string	El nombre del parámetro.	param2
ExampleValue	string	El valor de ejemplo.	example2
ParameterDataType	integer	El tipo de datos del parámetro. Valores válidos: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
WizardConnection	object	La información de la fuente de datos de la API generada en modo asistente.
TableName	string	El nombre de la tabla en el origen de datos.	t
ConnectionId	integer	El ID del origen de datos.	123
SqlMode	integer	El modo SQL. 0: SQL básico; 1: SQL avanzado.	0

Los detalles de los diferentes tipos de API se devuelven en diferentes campos. Las API de asistente usan el campo WizardDetails, las API de script usan el campo ScriptDetails y las API de registro usan el campo RegistrationDetails.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "Timeout": 10000,
    "Status": 1,
    "ApiId": 10000,
    "ApiMode": 0,
    "ProjectId": 10001,
    "ResponseContentType": 0,
    "CreatorId": "1234567",
    "VisibleRange": 0,
    "ModifiedTime": "2020-06-23T00:21:01+0800",
    "OperatorId": "2345678",
    "GroupId": "ab12**",
    "Description": "测试API描述",
    "RequestMethod": 0,
    "CreatedTime": "2020-06-23T00:21:01+0800",
    "ApiName": "测试API名称",
    "TenantId": 10001,
    "ApiPath": "/test/1",
    "Protocols": [
      0
    ],
    "RegistrationDetails": {
      "ServiceHost": "http://www.abc.com",
      "ServiceContentType": 0,
      "ServicePath": "/index",
      "SuccessfulResultSample": "{\"success\": true}",
      "FailedResultSample": "{\"success\": false}",
      "ServiceRequestBodyDescription": "{\"abc\":1}",
      "RegistrationErrorCodes": [
        {
          "ErrorMessage": "The connection does not exist",
          "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
          "ErrorSolution": "retry"
        }
      ],
      "RegistrationRequestParameters": [
        {
          "ParameterName": "name1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ExampleValue": "example1",
          "ParameterDataType": 0,
          "IsRequiredParameter": true
        }
      ]
    },
    "ScriptDetails": {
      "IsPagedResponse": true,
      "SuccessfulResultSample": "{\"success\": true}",
      "FailedResultSample": "{\"success\": false}",
      "Script": "select a from t",
      "ScriptErrorCodes": [
        {
          "ErrorMessage": "fail to call",
          "ErrorCode": "1001",
          "ErrorSolution": "retry"
        }
      ],
      "ScriptRequestParameters": [
        {
          "ParameterName": "param1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ExampleValue": "example1",
          "ParameterDataType": 0,
          "IsRequiredParameter": true
        }
      ],
      "ScriptResponseParameters": [
        {
          "ParameterDescription": "description2",
          "ParameterName": "param2",
          "ExampleValue": "example2",
          "ParameterDataType": 0
        }
      ],
      "ScriptConnection": {
        "TableName": "t",
        "ConnectionId": 123
      }
    },
    "WizardDetails": {
      "IsPagedResponse": true,
      "SuccessfulResultSample": "{\"success\": true}",
      "FailedResultSample": "{\"success\": false}",
      "WizardErrorCodes": [
        {
          "ErrorMessage": "fail to call",
          "ErrorCode": "1001",
          "ErrorSolution": "retry"
        }
      ],
      "WizardRequestParameters": [
        {
          "ParameterName": "param1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ExampleValue": "example1",
          "ParameterDataType": 0,
          "IsRequiredParameter": true
        }
      ],
      "WizardResponseParameters": [
        {
          "ParameterDescription": "description2",
          "ParameterName": "param2",
          "ExampleValue": "example2",
          "ParameterDataType": 0
        }
      ],
      "WizardConnection": {
        "TableName": "t",
        "ConnectionId": 123
      }
    },
    "SqlMode": 0
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. 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.