ListDataServiceAuthorizedApis - 获取获得授权的API信息列表

调用ListDataServiceAuthorizedApis获取获得授权的API信息列表。

调试

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

授权信息

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

请求参数

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

工作空间的 ID。

10000
PageNumberinteger

页码,从 1 开始,默认值为 1。

PageNumber
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TenantIdlong

该字段已废弃。租户 ID。

10001
ApiNameKeywordstring

API 名称的关键词,通过过滤获取 API 名称包含该关键词的 API。

我的API名称

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求 ID,一次请求的唯一标识。

0000-ABCD-EFG****
ErrorMessagestring

错误信息

The specified parameters are invalid.
Successboolean

调用是否成功。

true
ErrorCodestring

错误码。

1031203110005
Dataobject

获得授权的 API 信息。

PageNumberinteger

页码,和请求中的 PageNumber 一致。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TotalCountinteger

总记录数。

100
ApiAuthorizedListarray<object>

获得授权的 API 列表。

ApiAuthorizedobject
ApiIdlong

API 的 ID。

10002
ApiStatusinteger

API 的状态,可选枚举值包括 0(未发布)和 1(已发布)。

0
GrantOperatorIdstring

授权者的阿里云 ID。

23456
ProjectIdlong

工作空间的 ID。

10000
CreatorIdstring

API 负责人阿里云 ID

12345
GrantEndTimestring

API 的授权到期时间。

2020-06-24T00:21:01+0800
ModifiedTimestring

API 的最近更新时间。

2020-06-23T00:21:01+0800
GroupIdstring

分组 ID。

abcde123456789
GrantCreatedTimestring

API 的授权时间。

2020-06-23T00:21:01+0800
CreatedTimestring

API 的创建时间。

2020-06-23T00:21:01+0800
ApiNamestring

API 的名称。

我的API名称
TenantIdlong

租户 ID。

10001
ApiPathstring

API 的路径。

/test/1

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "Success": true,
  "ErrorCode": "1031203110005",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "ApiAuthorizedList": [
      {
        "ApiId": 10002,
        "ApiStatus": 0,
        "GrantOperatorId": "23456",
        "ProjectId": 10000,
        "CreatorId": "12345",
        "GrantEndTime": "2020-06-24T00:21:01+0800",
        "ModifiedTime": "2020-06-23T00:21:01+0800",
        "GroupId": "abcde123456789",
        "GrantCreatedTime": "2020-06-23T00:21:01+0800",
        "CreatedTime": "2020-06-23T00:21:01+0800",
        "ApiName": "我的API名称",
        "TenantId": 10001,
        "ApiPath": "/test/1"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁,请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误,请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误,请稍后再试。

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

变更历史

变更时间变更内容概要操作
2023-10-09OpenAPI 错误码发生变更查看变更详情