ListPermissionApplyOrders - DataWorks - Alibaba Cloud Documentation Center

Queries a list of permission request orders.

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
FlowStatus	integer	No	The status of the permission request order. Valid values: 1: to be processed 2: approved and authorized 3: approved but authorization failed 4: rejected Valid values: 0 1 2 3 4 5	1
WorkspaceId	integer	No	The ID of the DataWorks workspace that is associated with the permission request order. If you do not specify the parameter, the permission request orders of all workspaces are returned. You can go to the Workspace page in the DataWorks console to obtain the workspace ID.	12345
OrderType	integer	Yes	The type of the permission request order. The parameter value is 1 and cannot be changed. This value indicates ACL-based authorization.	1
MaxComputeProjectName	string	No	The name of the MaxCompute project with which the permission request order is associated. If you do not specify the parameter, the permission request orders of all MaxCompute projects are returned.	aMaxComputeProject
TableName	string	No	The name of the table with which the permission request order is associated. If you do not specify the parameter, the permission request orders of all tables are returned.	aTableName
StartTime	long	No	The beginning of the time range to query. You can query all the permissions request orders that have been submitted after the time. The parameter value is a UNIX timestamp. If you do not specify the parameter, all permission request orders are queried.	1616200471885
EndTime	long	No	The end of the time range to query. You can query all the permissions request orders that have been submitted before the time. The parameter value is a UNIX timestamp. If you do not specify the parameter, all permission request orders that are submitted before the current time are queried.	1617200471885
EngineType	string	Yes	The type of the compute engine with which the permission request order is associated. The parameter value is odps and cannot be changed. This value indicates that you can request permissions only on fields of tables in the MaxCompute compute engine.	odps
PageNum	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	100
QueryType	integer	Yes	The query type of the permission request order. Valid values: 0: The permission request orders you submitted. 1: The permission request orders you approved.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0bc1ec92159376****
ApplyOrders	object	The query results returned by page.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	150
ApplyOrder	array<object>	The list of the permission request orders.
Orders	object
ApplyBaseId	string	The ID of the Alibaba Cloud account that was used to submit the permission request order.	267842600408993176
ApplyTimestamp	long	The time when the permission request order was submitted. The parameter value is a UNIX timestamp.	1615284086000
FlowId	string	The ID of the permission request order.	ad8da78d-8135-455e-9486-27cf213fc140
FlowStatus	integer	The status of the permission request order. Valid values: 1: to be processed 2: approved and authorized 3: approved but authorization failed 4: rejected	2
ApproveContent	object	The content of the permission request order.
ApplyReason	string	The reason for your request. The administrator determines whether to approve the request based on the reason.	I need to use this table
OrderType	integer	The type of the permission request order. The parameter value is 1 and cannot be changed. This value indicates ACL-based authorization.	1
ProjectMeta	object	The content of the object on which you requested permissions.
WorkspaceName	string	The name of the DataWorks workspace that is associated with the MaxCompute project in which you requested permissions on a table.	aWorkspaceName
ObjectMetaList	array<object>	The information about the object on which you requested permissions.
ObjectMetaList	object
ObjectName	string	The name of the table on which you requested permissions.	aTableName
Actions	array
Actions	string	The permission that you want to request. If you want to request multiple permissions at the same time, separate them with commas (,). You can request only the SELECT, DESCRIBE, and DOWNLOAD permissions.	Select,Describe

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bc1ec92159376****",
  "ApplyOrders": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 150,
    "ApplyOrder": [
      {
        "ApplyBaseId": "267842600408993176",
        "ApplyTimestamp": 1615284086000,
        "FlowId": "ad8da78d-8135-455e-9486-27cf213fc140",
        "FlowStatus": 2,
        "ApproveContent": {
          "ApplyReason": "I need to use this table",
          "OrderType": 1,
          "ProjectMeta": {
            "WorkspaceName": "aWorkspaceName",
            "ObjectMetaList": [
              {
                "ObjectName": "aTableName",
                "Actions": [
                  "Select,Describe"
                ]
              }
            ]
          }
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history