ListProjectMembers を使用してワークスペースメンバーをクエリする - DataWorks

DataWorks ワークスペース内の既存のメンバーのリストを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID。	27
PageNumber	integer	任意	ページ番号。有効な値: 1～30。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーターです。
RequestId	string	リクエスト ID。	1AFAE64E-D1BE-432B-A9****
Data	object	返された結果。
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
TotalCount	integer	返されたエントリの総数。	3
ProjectMemberList	array<object>	DataWorks ワークスペースのメンバーに関する情報。
	array<object>
Status	string	メンバーのステータス。有効な値: 0: NORMAL。メンバーが正常な状態であることを示します。 1: FORBIDDEN。メンバーが無効になっていることを示します。 2: DELETED。メンバーが削除されていることを示します。	0
ProjectMemberId	string	メンバー ID。	121
Nick	string	メンバーのニックネーム。	zhangsan
ProjectMemberName	string	メンバーの名前。	张三
ProjectMemberType	string	メンバーのタイプ。有効な値: 1: USER_ALIYUN。メンバーが Alibaba Cloud アカウントであることを示します。 5: USER_UBACCOUNT。メンバーが RAM ユーザーであることを示します。 6: USER_STS_ROLE。メンバーが RAM ロールであることを示します。	1
ProjectRoleList	array<object>	メンバーに割り当てられているロール。
	object
ProjectRoleId	integer	ロール ID。	1
ProjectRoleType	string	ロールのタイプ。有効な値: 0: SYSTEM。ロールが組み込みロールであることを示します。 2: USER_CUSTOM。ロールがカスタムロールであることを示します。	0
ProjectRoleName	string	ロールの名前。DataWorks は組み込みロールを提供し、ビジネス要件に基づいてカスタムロールを作成できます。ロールの詳細については、「ユーザー、ロール、および権限の概要」をご参照ください。	访客
ProjectRoleCode	string	ロールのコード。DataWorks は組み込みロールを提供し、ビジネス要件に基づいてカスタムロールを作成できます。ロールの詳細については、「ユーザー、ロール、および権限の概要」をご参照ください。	role_project_guest

例

成功レスポンス

JSONJSON

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 3,
    "ProjectMemberList": [
      {
        "Status": "0",
        "ProjectMemberId": "121",
        "Nick": "zhangsan",
        "ProjectMemberName": "张三",
        "ProjectMemberType": "1",
        "ProjectRoleList": [
          {
            "ProjectRoleId": 1,
            "ProjectRoleType": "0",
            "ProjectRoleName": "访客",
            "ProjectRoleCode": "role_project_guest"
          }
        ]
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。