呼叫 ListDataServiceAuthorizedApis 取得已獲授權的 API 資訊列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
是 |
工作空間的 ID。可透過 ListProjects 介面返回的 PageResult.ProjectList[].ProjectId 欄位取得。 |
10000 |
| PageNumber |
integer |
否 |
頁碼，從 1 開始，預設值為 1。 |
1 |
| PageSize |
integer |
否 |
每頁顯示的筆數，預設為 10 筆，最大 50 筆。 |
10 |
| TenantId |
integer |
否 |
該欄位已廢棄。租戶 ID。 |
10001 |
| ApiNameKeyword |
string |
否 |
API 名稱的關鍵詞，透過篩選取得 API 名稱包含該關鍵詞的 API。 |
我的API名稱 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 狀態碼。 |
200 |
| RequestId |
string |
請求 ID，一次請求的唯一識別碼。 |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
錯誤訊息。 |
The specified parameters are invalid. |
| Success |
boolean |
呼叫是否成功。 |
true |
| ErrorCode |
string |
錯誤碼。 |
1031203110005 |
| Data |
object |
已獲授權的 API 資訊。 |
|
| PageNumber |
integer |
頁碼，與請求中的 PageNumber 一致。 |
1 |
| PageSize |
integer |
每頁顯示的筆數，預設為 10 筆，最大 100 筆。 |
10 |
| TotalCount |
integer |
總記錄數。 |
100 |
| ApiAuthorizedList |
array<object> |
已獲授權的 API 列表。 |
|
|
object |
|||
| ApiId |
integer |
API 的 ID。 |
10002 |
| ApiStatus |
integer |
API 的狀態，可選枚舉值包括 0（未發布）和 1（發行）。 |
0 |
| GrantOperatorId |
string |
授權者的阿里雲 ID。 |
23456 |
| ProjectId |
integer |
工作空間的 ID。 |
10000 |
| CreatorId |
string |
API 負責人阿里雲 ID |
12345 |
| GrantEndTime |
string |
API 的授權到期時間。 |
2020-06-24T00:21:01+0800 |
| ModifiedTime |
string |
API 的最新動向時間。 |
2020-06-23T00:21:01+0800 |
| GroupId |
string |
分組 ID。 |
abcde123456789 |
| GrantCreatedTime |
string |
API 的授權時間。 |
2020-06-23T00:21:01+0800 |
| CreatedTime |
string |
API 的建立時間。 |
2020-06-23T00:21:01+0800 |
| ApiName |
string |
API 的名稱。 |
My API name |
| TenantId |
integer |
租戶 ID。 |
10001 |
| ApiPath |
string |
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": "My API name",
"TenantId": 10001,
"ApiPath": "/test/1"
}
]
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。