DocsICP FilingConsole
Documentation
Home Page DataWorks Developer Reference API Reference (2020-05-18) API catalog Security Center. GetPermissionApplyOrderDetail

GetPermissionApplyOrderDetail

Updated at:
Copy as MD
Product
My Favorites

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

Operation description

Note: The 2020 version of OpenAPI will be discontinued. 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 None

Request parameters

Parameter

Type

Required

Description

Example
FlowId

string

Yes

The ID of the permission application 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 struct.

ApplyOrderDetail

object

The details of the application order.

ApplyBaseId

string

The UID of the Alibaba Cloud account that submitted the application order.

26784260040899****
ApplyTimestamp

integer

The time when the application order was submitted. The value is a UNIX timestamp.

1615284086000
ApproveAccountList

array<object>

The list of Alibaba Cloud accounts responsible for reviewing the application order.

object

The response struct.

BaseId

string

The UID of the Alibaba Cloud account responsible for reviewing the application order.

182293110403****
ApproveContent

object

The specific content of the application.

ApplyReason

string

The reason for the application, which is used as a reference for administrator approval.

I need to use this table
Deadline

integer

The expiration time of the requested permission. The value is a UNIX timestamp. If LabelSecurity is not enabled for the MaxCompute project, or the security level of the requested table field is 0 or less than or equal to the security level of the requesting account, only permanent permissions can be requested.

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 requested object belongs.

MaxComputeProjectName

string

The MaxCompute project in which the requested object resides.

aMaxComputeProject
ObjectMetaList

array<object>

The details of the requested object.

array<object>

The response struct.

Actions

array

string

ColumnMetaList

array<object>

The column field information of the requested object.

object

The response struct.

ColumnActions

array

string

ColumnComment

string

The description of the requested column.

Field description
ColumnName

string

The name of the requested column.

aColumnName
SecurityLevel

string

The security level of the requested column. Valid values: 0 to 9.

9
ObjectName

string

The name of the requested table.

aTableName
WorkspaceId

integer

The ID of the DataWorks workspace in which the requested object resides.

123456
FinishAapprovalTimestamp

integer

The time when the final approval was completed. The value is a UNIX timestamp.

1757496687000
FinishApprovalComment

string

The final approval comment.

agree
FlowId

string

The ID of the application order.

ad8da78d-8135-455e-9486-27cf213f****
FlowStatus

integer

The status of the application order. Valid values:

  • 1: Pending approval.

  • 2: Approved and authorization succeeded.

  • 3: Approved but authorization failed.

  • 4: Rejected.

  • 5: Withdrawn.

2
GranteeObjectList

array<object>

The account information of the permission applicant.

object

The response struct.

GranteeId

string

The UID of the Alibaba Cloud account that requested the permission.

26784260040899****
GranteeName

string

The name of the Alibaba Cloud account that requested the permission. The format is the same as the MaxCompute account format.

  • Alibaba Cloud account: ALIYUN$+account name.

  • RAM user: RAM$+account name.

RAM$dataworks_3h1_1:StsRamUser(StsRamUser)
GranteeType

integer

The principal type of the permission applicant. Currently, only the value 1 (user) is supported.

1
GranteeTypeSub

integer

The principal subtype of the permission applicant. Valid values:

  • 101: Production Alibaba Cloud account.

  • 103: Personal Alibaba Cloud account.

  • 105: Alibaba Cloud account for which permissions are requested on behalf of another user.

103
RequestId

string

The request ID.

0bc1ec92159376****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：CreatePermissionApplyOrderNext：ListPermissionApplyOrders