Use GetPermissionApplyOrderDetail to query permission request details - DataWorks - Alibaba Cloud - DataWorks

Queries the details of a permission request order. Note: The 2020 version of OpenAPI will be discontinued. Please migrate to the 2024 version of OpenAPI as soon as possible — GetApplicationContents/GetProcessInstance.

Operation description

Note: The 2020 version of OpenAPI will be discontinued. Please migrate to the 2024 version of OpenAPI as soon as possible — GetApplicationContents/GetProcessInstance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowId	string	Yes	The ID of the permission request order. You can call the ListPermissionApplyOrders operation to obtain the ID.	48f36729-05f9-4a40-9286-933fd940****

Response elements

Element	Type	Description	Example
	object	The response structure.
RequestId	string	The request ID.	0bc1ec92159376****
ApplyOrderDetail	object	The details of the request order.
ApplyBaseId	string	The UID of the Alibaba Cloud account that submitted the request order.	26784260040899****
ApplyTimestamp	integer	The time when the request order was submitted, displayed as a UNIX timestamp.	1615284086000
FlowId	string	The ID of the request order.	ad8da78d-8135-455e-9486-27cf213f****
FlowStatus	integer	The status of the request order. Valid values: 1: Pending approval. 2: Approved and authorization succeeded. 3: Approved but authorization failed. 4: Rejected. 5: Withdrawn.	2
ApproveAccountList	array<object>	The list of Alibaba Cloud accounts that approved the request order.
	object	The response structure.
BaseId	string	The UID of the Alibaba Cloud account that approved the application order.	182293110403****
GranteeObjectList	array<object>	The information about the accounts that requested permissions.
	object	The response structure.
GranteeType	integer	The type of the principal that applied for permissions. Currently, only the value 1 (user) is supported.	1
GranteeTypeSub	integer	The subtype of the principal that applied for permissions. Valid values: 101: production Alibaba Cloud account. 103: personal Alibaba Cloud account. 105: Alibaba Cloud account applied on behalf of another user.	103
GranteeName	string	The name of the Alibaba Cloud account that applied for permissions. The format is the same as the MaxCompute account format. An Alibaba Cloud account is in the format of ALIYUN$+account name. A RAM user is in the format of RAM$+account name.	RAM$dataworks_3h1_1:StsRamUser(StsRamUser)
GranteeId	string	The UID of the Alibaba Cloud account that applied for permissions.	26784260040899****
ApproveContent	object	The specific content of the request.
ApplyReason	string	The reason for the application, which is used as a reference for the administrator during approval.	I need to use this table
Deadline	integer	The expiration time of the applied permissions. The value is a UNIX timestamp. If LabelSecurity is not enabled for the MaxCompute project, or the security level of the applied table field is 0 or less than or equal to the security level of the applicant account, only permanent permissions can be applied for.	1617115071885
OrderType	integer	The type of the application order. Currently, only the value 1 is supported, which indicates an object ACL permission application.	1
ProjectMeta	object	The project and workspace information to which the applied object belongs.
MaxComputeProjectName	string	The MaxCompute project to which the applied object belongs.	aMaxComputeProject
WorkspaceId	integer	The ID of the DataWorks workspace to which the applied object belongs.	123456
ObjectMetaList	array<object>	The details of the applied object.
	array<object>	The response struct.
ObjectName	string	The name of the applied table.	aTableName
ColumnMetaList	array<object>	The column field information of the applied object.
	object	The response struct.
ColumnName	string	The name of the applied column.	aColumnName
ColumnComment	string	The description of the applied column.	Field description
SecurityLevel	string	The security level of the applied column. Valid values: 0 to 9.	9
ColumnActions	array
	string
Actions	array
	string
FinishAapprovalTimestamp	integer	The time when the final approval was completed, displayed as a UNIX timestamp.	1757496687000
FinishApprovalComment	string	The final approval comment.	agree

Examples

Success response

JSON format

{
  "RequestId": "0bc1ec92159376****",
  "ApplyOrderDetail": {
    "ApplyBaseId": "26784260040899****",
    "ApplyTimestamp": 1615284086000,
    "FlowId": "ad8da78d-8135-455e-9486-27cf213f****",
    "FlowStatus": 2,
    "ApproveAccountList": [
      {
        "BaseId": "182293110403****"
      }
    ],
    "GranteeObjectList": [
      {
        "GranteeType": 1,
        "GranteeTypeSub": 103,
        "GranteeName": "RAM$dataworks_3h1_1:StsRamUser(StsRamUser)",
        "GranteeId": "26784260040899****"
      }
    ],
    "ApproveContent": {
      "ApplyReason": "I need to use this table",
      "Deadline": 1617115071885,
      "OrderType": 1,
      "ProjectMeta": {
        "MaxComputeProjectName": "aMaxComputeProject",
        "WorkspaceId": 123456,
        "ObjectMetaList": [
          {
            "ObjectName": "aTableName",
            "ColumnMetaList": [
              {
                "ColumnName": "aColumnName",
                "ColumnComment": "Field description",
                "SecurityLevel": "9",
                "ColumnActions": [
                  ""
                ]
              }
            ],
            "Actions": [
              ""
            ]
          }
        ]
      }
    },
    "FinishAapprovalTimestamp": 1757496687000,
    "FinishApprovalComment": "agree"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.