DataService で権限が付与された API のリストを取得します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
必須 |
ワークスペースの ID。この値は、ListProjects 操作によって返される PageResult.ProjectList[].ProjectId フィールドから取得できます。 |
10000 |
| PageNumber |
integer |
任意 |
ページ番号。ページは 1 から始まります。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。最大値: 50。 |
10 |
| TenantId |
integer |
任意 |
[非推奨] テナントの ID。 |
10001 |
| ApiNameKeyword |
string |
任意 |
API 名のキーワード。このパラメーターは、名前に指定されたキーワードを含む API をフィルター処理するために使用されます。 |
MyAPIName |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状態コード。 |
200 |
| RequestId |
string |
リクエストの ID。リクエストの一意識別子です。 |
0000-ABCD-EFG**** |
| ErrorMessage |
string |
エラーメッセージ。 |
指定されたパラメーターが有効ではありません。 |
| Success |
boolean |
呼び出しが成功したかどうかを示します。 |
true |
| ErrorCode |
string |
エラーコード。 |
1031203110005 |
| Data |
object |
権限付与された API に関する情報。 |
|
| PageNumber |
integer |
ページ番号。リクエスト内の PageNumber 値と同じです。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。 |
10 |
| TotalCount |
integer |
レコードの総数。 |
100 |
| ApiAuthorizedList |
array<object> |
権限が付与された API のリスト。 |
|
|
object |
|||
| ApiId |
integer |
API ID。 |
10002 |
| ApiStatus |
integer |
API のステータス。有効な値：0、1。値 0 は API が未公開であることを示し、値 1 は API が公開済みであることを示します。 |
0 |
| GrantOperatorId |
string |
API のアクセス権限を付与したユーザーが使用する Alibaba Cloud アカウントの ID。 |
23456 |
| ProjectId |
integer |
ワークスペース ID。 |
10000 |
| CreatorId |
string |
API の所有者が使用する Alibaba Cloud アカウントの 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 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。