文档

ListApiDatasource - 查询API数据源列表

更新时间:

查询API数据源列表。

接口说明

具体的参数说明详见创建 API 数据源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
WorkspaceIdstring

工作空间 ID。

89713491-cb4f-4579-b889-e82c35f1****
PageNuminteger

API 数据源列表的当前页码:

  • 起始值:1
  • 默认值:1
1
PageSizeinteger

分页查询时的每页行数:

  • 默认值:10
  • 最大值:100
10
KeyWordstring

API 数据源名称的关键字。

测试

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回查询结果。

PageNuminteger

请求获取的数据页码数,用于翻页。

1
PageSizeinteger

请求接口时设置的每页行数。

10
Dataobject []

查询到的 API 数据源列表。

ApiIdstring

API 数据源的 ID。

0f2c3c6409be4dc0810f2a5785e816a8
JobIdstring

任务 ID。

REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8
ShowNamestring

API 数据源的名称。

测试数据源
DataSizefloat

API 数据源的数据量。

  • 单位:KB
0.39746094
StatusTypeinteger

API 数据源同步任务状态。

枚举值:
  • 0待运行
  • 1运行中
  • 2成功
  • 3失败
2
Parametersstring

JSONArray 格式的参数配置。

  • name:参数名称
  • value:参数值
[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]
Bodystring

JSON 格式的查询语句参数配置,用户可以自行定义。

{"key1":"value1"}
DateUpdateTimestring

API 数据源最后同步时间。

2022-05-25 16:19:43
GmtCreatestring

创建时间。

2022-05-25 16:19:43
GmtModifiedstring

修改时间。

2022-05-25 16:19:43
TotalNuminteger

总行数。

1
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

访问错误中心查看更多错误码。

  • 本页导读 (0)
文档反馈