ListPermissionApplyOrders - API| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListPermissionApplyOrders	The operation that you want to perform.
EngineType	String	Yes	odps	The type of the compute engine in which you submitted a permission request order. The parameter value is odps and cannot be changed. odps indicates that you can request permissions only on tables in the MaxCompute compute engine.
OrderType	Integer	Yes	1	The type of the permission request order. The parameter value is 1 and cannot be changed. 1 indicates that ACL-based authorization is requested.
QueryType	Integer	Yes	1	The query type of the permission request order. Valid values: 0: The permission request orders you submitted. 1: The permission request orders you approved.
RegionId	String	Yes	cn-shanghai	The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.
FlowStatus	Integer	No	1	The status of the permission request order. Valid values: 1: pending approval 2: approved and authorized 3: approved but authorization failed 4: rejected
WorkspaceId	Integer	No	12345	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 Management page in the DataWorks console to query the workspace ID.
MaxComputeProjectName	String	No	aMaxComputeProject	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.
TableName	String	No	aTableName	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.
StartTime	Long	No	1616200471885	The start time. 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 the permission request orders are queried.
EndTime	Long	No	1617200471885	The end time. 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 the permission request orders that are submitted before the current time are queried.
PageNum	Integer	No	1	The number of the page to return. Pages start from page 1. Default value: 1.
PageSize	Integer	No	100	The number of entries to return on each page. Default value: 10. Maximum value: 100.

Response parameters


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

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListPermissionApplyOrders
&EngineType=odps
&OrderType=1
&QueryType=1
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.