ListDataServiceAuthorizedApis - DataWorks - Alibaba Cloud Documentation Center

Queries the APIs that you are authorized to access.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The workspace ID.	10000
PageNumber	integer	Yes	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page. Default value: 10. Maximum value: 100.	10
TenantId	long	No	The tenant ID. This parameter is deprecated.	10001
ApiNameKeyword	string	No	The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.	My API Name

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0000-ABCD-EFG****
ErrorMessage	string	The error message.	The specified parameters are invalid.
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	1031203110005
Data	object	The information about the APIs that you are authorized to access.
PageNumber	integer	The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of entries returned.	100
ApiAuthorizedList	array<object>	The APIs that you are authorized to access.
ApiAuthorized	object
ApiId	long	The API ID.	10002
ApiStatus	integer	The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.	0
GrantOperatorId	string	The ID of the Alibaba Cloud account used by the user who granted the access permissions on the API.	23456
ProjectId	long	The workspace ID.	10000
CreatorId	string	The ID of the Alibaba Cloud account used by the API owner.	12345
GrantEndTime	string	The expiration time of the access permissions granted on the API.	2020-06-24T00:21:01+0800
ModifiedTime	string	The time when the API was last updated.	2020-06-23T00:21:01+0800
GroupId	string	The group ID.	abcde123456789
GrantCreatedTime	string	The time when the access permissions on the API were granted.	2020-06-23T00:21:01+0800
CreatedTime	string	The time when the API was created.	2020-06-23T00:21:01+0800
ApiName	string	The name of the API.	My API Name
TenantId	long	The tenant ID.	10001
ApiPath	string	The path of the API.	/test/1

Examples

Sample success responses

JSONformat

{
  "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": "My API Name\n",
        "TenantId": 10001,
        "ApiPath": "/test/1"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
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.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

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

Change history

Change time	Summary of changes	Operation
2023-10-09	The Error code has changed	View Change Details