ListApiDatasource - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries API data sources.

Operation description

For more information about the parameters, see Create an API data source.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:ListApiDatasource	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID.	89713491-cb4f-4579-b889-e82c35f1****
PageNum	integer	No	Current page number for API data source list: Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of rows per page in a paged query. Default value: 10. Valid values: 1 to 100.	10
KeyWord	string	No	The keyword of the API data source name.	test

Response parameters

Parameter	Type	Description	Example
	object	The information returned.
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The query results are returned.
Data	array<object>	The list of API data sources that were queried.
Data	object
ApiId	string	The ID of the API data source.	0f2c3c6409be4dc0810f2a5785e816a8
Body	string	The parameter configuration of the query statement in JSON format. You can customize the parameter configuration.	{"key1":"value1"}
DataSize	float	The data volume of the API data source. Unit: Kbit/s	0.39746094
DateUpdateTime	string	The last synchronization time of the API data source.	2022-05-25 16:19:43
GmtCreate	string	The time when the quota plan was created.	2022-05-25 16:19:43
GmtModified	string	The time when the optimization job was modified.	2022-05-25 16:19:43
JobId	string	The job ID.	REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8
Parameters	string	The parameter configurations in the JSONArray format. name: parameter name value: the parameter value	[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]
ShowName	string	The name of the API data source.	test data source
StatusType	integer	The status of the API data source synchronization task. Valid values: 0: the to be run. 1: The is running. 2: The is successfully. 3: failed.	2
PageNum	integer	The page number.	1
PageSize	integer	The number of rows per page set when the interface is requested.	10
TotalNum	integer	The total number of rows.	1
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "ApiId": "0f2c3c6409be4dc0810f2a5785e816a8",
        "Body": {
          "key1": "value1"
        },
        "DataSize": 0.39746094,
        "DateUpdateTime": "2022-05-25 16:19:43",
        "GmtCreate": "2022-05-25 16:19:43",
        "GmtModified": "2022-05-25 16:19:43",
        "JobId": "REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8",
        "Parameters": [
          {
            "name": "token",
            "value": "xxxxxxxxxxxx"
          },
          {
            "name": "pageSize",
            "value": 100
          }
        ],
        "ShowName": "test data source",
        "StatusType": 2
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.

For a list of error codes, visit the Service error codes.