ListMyApplications

Updated at:

Queries all resource access permission application orders initiated by the current user.

Operation description

Request description

  • This API supports paginated queries, controlled by the NextToken and PageSize parameters.

  • DefSchema is a required parameter that specifies the resource type.

  • The ResourceType list can contain multiple resource types for more precise filtering of application orders.

  • You can set StartTime and EndTime to limit the time range of the query.

  • Statuses allows you to filter application orders by specific statuses, such as pending approval and authorized.

  • If you need to filter by specific resources or authorization targets, you can provide detailed information through the Resource and Grantee fields.

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:ListMyApplications

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

DefSchema

string

Yes

Filters by resource type.

Note: The resource types supported by the system for applications are constrained by ResourceSchema.name.

See also: ResourceSchema documentation for International site

MaxCompute

ResourceType

array

Yes

Filters by minimum permission resource type.

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

See also: ResourceSchema documentation for International site

string

No

The resource type.

table

Resource

object

No

Filters by resource with exact or generalized matching. The resource description is constrained by ResourceSchema.

See also: ResourceSchema documentation for International site

DefSchema

string

No

The resource type.

Note: The resource types supported by the system for applications are constrained by ResourceSchema.name.

See also: ResourceSchema documentation for International site

MaxCompute

DefVersion

string

No

The resource parsing version, which is constrained by ResourceSchema.version.

ResourceSchema documentation for International site

v1.0.0

MetaData

object

No

The resource metadata.

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

See also: ResourceSchema documentation for International site

any

No

The resource metadata.

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

StartTime

integer

Yes

The start time of the application period (millisecond timestamp).

1771948800000

EndTime

integer

Yes

The end time of the application period (millisecond timestamp).

1779724799999

Statuses

array

No

Filters by approval status. Valid values:

  • WaitApproval: pending approval.

  • Confirmed: pending authorization.

  • RejectApproval: approval rejected.

  • AuthorizeSucceed: authorization succeeded.

  • AuthorizeFailed: authorization failed.

  • Deleted: deleted.

  • Canceled: withdrawn.

Deleted

string

No

The resource status.

WAIT_APPROVAL

NextToken

string

No

The pagination cursor.

eyJpZCI6MTIzfQ==

PageSize

integer

No

The number of entries per page. Default value: 10. Maximum value: 200.

20

Response elements

Element

Type

Description

Example

object

The paginated result.

RequestId

string

The request ID, which is a UUID.

0bc5df3a17****903790e8e8a

Data

object

The data part of the paginated result.

PageSize

integer

The number of entries per page. Default value: 10. Maximum value: 200.

20

NextToken

string

The pagination cursor.

eyJpZCI6NDU2fQ==

HasMore

boolean

Indicates whether more data is available.

false

Data

array<object>

The list of application order details.

array<object>

The approval process and application content.

ProcessInstanceId

string

The process instance ID.

176906667488145

DefSchema

string

The resource type.

MaxCompute

Reason

string

The reason for the application.

Business requirement

ApplicationTime

integer

The time when the application was initiated.

1779695088000

Status

string

The approval status. Valid values:

  • WaitApproval: pending approval.

  • Confirmed: pending authorization.

  • RejectApproval: approval rejected.

  • AuthorizeSucceed: authorization succeeded.

  • AuthorizeFailed: authorization failed.

  • Deleted: deleted.

  • Canceled: withdrawn.

Deleted

Contents

array<object>

The application content.

array<object>

The application content.

Id

string

The primary key of the application content.

a8aa620037bb410ea13837f9b4d053d8

ProcessInstanceId

string

The approval process instance ID of the initiated application.

777799223

TenantId

string

The tenant ID.

69973837489

ResourceName

string

The minimum permission resource type.

table

DefSchema

string

The resource type.

MAXCOMPUTE

AuthMethod

string

The authorization method.

default

Resource

object

The resource declaration.

DefSchema

string

The ResourceSchema.name on which the resource parsing depends.

MaxCompute

DefVersion

string

The ResourceSchema.version on which the resource parsing depends.

v1.0.0

MetaData

object

The resource metadata, whose content is constrained by ResourceSchema.

any

The resource content.

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

Grantee

object

The authorization target.

PrincipalType

string

The principal type for authorization:

  • RamRole

  • RamUser

  • DataworksTenantMember

  • DataworksTenantRole

  • DataworksProjectMember

  • DataworksProjectRole

  • DlfRole

RamRole

PrincipalId

string

The principal ID for authorization:

  • RamUser: DataWorks UserId.

  • RamRole: DataWorks UserId prefixed with "ROLE_".

  • DataworksTenantMember: DataWorks UserId.

  • DataworksTenantRole: DataWorks tenant roleCode.

  • DataworksProjectRole: DataWorks workspace roleCode.

  • DataworksProjectMember: DataWorks UserId.

  • DlfRole: DlfNext role name.

ROLE_3133343434

AccessTypes

array

The resource operation permissions requested in the application.

string

The permission.

select

FinalAccessTypes

array

The resource operation permissions that were finally approved.

string

The permission.

select

ExpirationTime

integer

The permission expiration date (millisecond timestamp).

1782354014507

Status

string

The approval status. Valid values:

  • WaitApproval: pending approval.

  • Confirmed: pending authorization.

  • RejectApproval: approval rejected.

  • AuthorizeSucceed: authorization succeeded.

  • AuthorizeFailed: authorization failed.

  • Deleted: deleted.

  • Canceled: withdrawn.

Deleted

CreateTime

integer

The creation time.

2022-11-29 15:04:52

UpdateTime

integer

The update time.

2022-07-08 23:58:59

Examples

Success response

JSON format

{
  "RequestId": "0bc5df3a17****903790e8e8a",
  "Data": {
    "PageSize": 20,
    "NextToken": "eyJpZCI6NDU2fQ==",
    "HasMore": false,
    "Data": [
      {
        "ProcessInstanceId": "176906667488145",
        "DefSchema": "MaxCompute",
        "Reason": "业务需要",
        "ApplicationTime": 1779695088000,
        "Status": "Deleted",
        "Contents": [
          {
            "Id": "a8aa620037bb410ea13837f9b4d053d8",
            "ProcessInstanceId": "777799223",
            "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              }\n"
              }
            },
            "Grantee": {
              "PrincipalType": "RamRole",
              "PrincipalId": "ROLE_3133343434"
            },
            "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.