ListPendingApprovals

更新时间:
复制 MD 格式

Retrieves the list of pending permission request orders for which the current user is the approver.

Operation description

Request Description

This API is used to query all pending permission request orders for which the current logged-in user is the approver. It supports filtering by multiple conditions, including resource type, time range, and approval status, to more precisely locate specific request orders.

  • ResourceType: Specifies the resource type (such as table), which can have multiple values.

  • Resource: Provides specific resource search conditions, such as the project, database, or table name.

  • StartTime and EndTime: Define the time range during which the request was submitted.

  • Statuses: Allows filtering results by approval status, for example, to view only pending approval requests.

  • Grantee: Filters request orders based on the authorization principal information.

  • AccessTypes: Filters based on the specific permission types requested (such as read or update).

  • PageSize and NextToken: Used for pagination control, specifying the amount of data returned per request and the cursor needed to retrieve the next page of data.

Notes:

  • If no filtering conditions are provided, all matching records are returned by default.

  • The NextToken parameter can be empty or omitted for the first call. Subsequent page requests must use the NextToken value provided in the previous response.

  • The default value of PageSize is 10, and the maximum value is 200. If the specified value exceeds the maximum limit, the maximum value is used.

  • When there is no more data to return, the HasMore field is set to false, and NextToken will be empty or absent.

Response Description

After a successful call to this API, the response body contains paginated results and detailed information for each request order, such as the application time, resource description, authorization principal, requested permissions, and more. Additionally, the approval process status and other related metadata are provided.

  • Data: The paginated result set, including page size (PageSize), cursor (NextToken), and whether more data is available (HasMore).

  • ApplicationQueryResponse: The specific content of each request order, including the reason for the request, submission time, status, and a detailed list of request content.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

DefSchema

string

Yes

Filters by resource type.

Note: The supported resource types for requests are constrained by ResourceSchema.name.

Reference: ResourceSchema International Documentation

MaxCompute

ResourceType

array

Yes

Filters by minimum permission resource type.

Note: The minimum permission resource type is constrained by ResourceSchema.resources[*].isValidLeaf being true.

Reference: ResourceSchema International Documentation

["table", "column"]

string

No

Resource type

table

Resource

object

No

Filters by resource with exact or fuzzy matching. Resource descriptions are constrained by ResourceSchema.

Reference: ResourceSchema International Documentation

DefSchema

string

No

Resource type.

Note: The supported resource types for requests are constrained by ResourceSchema.name.

Reference: ResourceSchema International Documentation

MaxCompute

DefVersion

string

No

Resource parsing version is constrained by ResourceSchema.version.

Reference: ResourceSchema International Documentation

v1.0.0

MetaData

object

No

Resource metadata.

Note: Metadata is constrained by ResourceSchema.resources. A valid resource declaration must include the full path metadata declaration from level 0 to the validLeaf level.

Reference: ResourceSchema International Documentation

any

No

Resource metadata

{ "workspace": "449056", "project": "sync_destination" }

StartTime

integer

No

Start time of the application period (millisecond timestamp).

1771948800000

EndTime

integer

No

End time of the application period (millisecond timestamp).

1779724799999

Grantee

object

No

Filters by authorization principal.

Note: The supported authorization principal types are constrained by ResourceSchema.authPrincipal.

Reference: ResourceSchema International Documentation

PrincipalType

string

No

Authorization principal type.

RamRole

PrincipalId

string

No

Authorization principal ID.

ROLE_3133343434

AccessTypes

array

No

Filters by requested permissions.

Note: Different resource levels support different permission types. All are uniformly constrained by ResourceSchema.isValidLeaf, accessTypeRestrictions, and authMethodAccessTypes.

Reference: ResourceSchema International Documentation

string

No

Permission

select

NextToken

string

No

Cursor.

eyJpZCI6MTIzfQ==

PageSize

integer

No

Page size (default: 10, maximum: 200).

20

Response elements

Element

Type

Description

Example

object

API request response. The error code is non-empty when the call fails.

RequestId

string

API request ID, generated as UUID.

0bc5df3a17****903790e8e8a

Data

object

Paginated results.

PageSize

integer

Page size (default: 10, maximum: 200).

10

NextToken

string

Cursor.

eyJpZCI6MTIzfQ==

HasMore

boolean

Whether more data is available.

false

Data

array<object>

Data list in the paginated results.

array<object>

Approval process and request content.

ProcessInstanceId

string

The process instance ID.

176906667488145

DefSchema

string

The resource type.

MaxCompute

Reason

string

The reason for the request.

业务需要

ApplicationTime

integer

The submission time of the request.

申请时间

Status

string

The approval status. Valid values:

  • WaitApproval: Pending approval

  • Confirmed: Pending authorization

  • RejectApproval: Rejected

  • AuthorizeSucceed: Authorization successful

  • AuthorizeFailed: Authorization failed

  • Deleted: Deleted

  • Canceled: Canceled

Deleted

Contents

array<object>

The content of the request.

array<object>

The requested items.

Id

string

The unique identifier of the requested item.

210001918826

ProcessInstanceId

string

The process instance ID.

176906667488145

TenantId

string

The tenant ID.

69973837489

ResourceName

string

The type of the resource, such as a table or function.

table

DefSchema

string

The resource type.

MaxCompute

AuthMethod

string

The authorization method.

default

Resource

object

The resource declaration.

DefSchema

string

The name of the ResourceSchema used to parse the resource.

MaxCompute

DefVersion

string

The version of the ResourceSchema used to parse the resource.

v1.0.0

MetaData

object

The resource metadata. The content is constrained by the DefSchema.

any

The content of the resource metadata.

{ "schema": "default", "threeTierModel": false, "project": "sync_dtestn", "workspace": "4477656", "table": "order", "tenant": "524257424864736" }

Grantee

object

Information about the grantee.

PrincipalType

string

The principal type. Valid values:

  • RamRole: A RAM role.

  • RamUser: A RAM user.

  • DataWorksTenantMember: A DataWorks tenant member.

  • DataWorksTenantRole: A DataWorks tenant role.

  • DataWorksProjectMember: A DataWorks workspace member.

  • DataWorksProjectRole: A DataWorks workspace role.

  • DlfRole: A DLF role.

RamUser

PrincipalId

string

The principal ID.

Note: The meaning of this ID varies based on the principalType.

  • If the principalType is RamUser, this is the DataWorks user ID.

  • If the principalType is RamRole, this is the DataWorks user ID, prefixed with "ROLE_".

  • If the principalType is DataWorksTenantMember, this is the DataWorks user ID.

  • If the principalType is DataWorksTenantRole, this is the DataWorks tenant role code.

  • If the principalType is DataWorksProjectRole, this is the DataWorks workspace role code.

  • If the principalType is DataWorksProjectMember, this is the DataWorks user ID.

  • If the principalType is DlfRole, this is the DLF role name.

213463068144525171

AccessTypes

array

The permissions requested for the resource.

string

A permission.

select

FinalAccessTypes

array

The final permissions granted after approval.

string

A granted permission.

select

ExpirationTime

integer

The permission expiration time, in milliseconds since the Unix epoch.

1782354014507

Status

string

The approval status. Valid values:

  • WaitApproval: Pending approval

  • Confirmed: Pending authorization

  • RejectApproval: Rejected

  • AuthorizeSucceed: Authorization successful

  • AuthorizeFailed: Authorization failed

  • Deleted: Deleted

  • Canceled: Canceled

Deleted

CreateTime

integer

The creation time of the entry.

2025-09-11 10:13:21

UpdateTime

integer

The time the entry was last updated.

2022-07-06 19:13:05

Examples

Success response

JSON format

{
  "RequestId": "0bc5df3a17****903790e8e8a",
  "Data": {
    "PageSize": 10,
    "NextToken": "eyJpZCI6MTIzfQ==",
    "HasMore": false,
    "Data": [
      {
        "ProcessInstanceId": "176906667488145",
        "DefSchema": "MaxCompute",
        "Reason": "业务需要",
        "ApplicationTime": 0,
        "Status": "Deleted",
        "Contents": [
          {
            "Id": "210001918826",
            "ProcessInstanceId": "176906667488145",
            "TenantId": "69973837489",
            "ResourceName": "table",
            "DefSchema": "MaxCompute",
            "AuthMethod": "default",
            "Resource": {
              "DefSchema": "MaxCompute",
              "DefVersion": "v1.0.0",
              "MetaData": {
                "key": "{\n                \"schema\": \"default\",\n                \"threeTierModel\": false,\n                \"project\": \"sync_dtestn\",\n                \"workspace\": \"4477656\",\n                \"table\": \"order\",\n                \"tenant\": \"524257424864736\"\n              }"
              }
            },
            "Grantee": {
              "PrincipalType": "RamUser",
              "PrincipalId": "213463068144525171"
            },
            "AccessTypes": [
              "select"
            ],
            "FinalAccessTypes": [
              "select"
            ],
            "ExpirationTime": 1782354014507,
            "Status": "Deleted",
            "CreateTime": 0,
            "UpdateTime": 0
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.