All Products
Search
Document Center

DataWorks:CreatePermissionApplyOrder

Last Updated:Nov 21, 2024

Creates a permission request order.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ApplyUserIdsstringYes

The ID of the Alibaba Cloud account for which you want to request permissions. If you want to request permissions for multiple Alibaba Cloud accounts, separate the IDs of the accounts with commas (,).

267842600408993176,267842600408993177
DeadlinelongNo

The expiration time of the permissions that you request. This value is a UNIX timestamp. The default value is January 1, 2065. If LabelSecurity is disabled for the MaxCompute project in which you want to request permissions on the fields of a table, or the security level of the fields is 0 or is lower than or equal to the security level of the Alibaba Cloud account for which you want to request permissions, you can request only permanent permissions. You can go to the Workspace Management page in the DataWorks console, click MaxCompute Management in the left-side navigation pane, and then check whether column-level access control is enabled. You can go to your DataWorks workspace, view the security level of the fields in Data Map, and then view the security level of the Alibaba Cloud account on the User Management page.

1617115071885
ApplyReasonstringYes

The reason for your request. The administrator determines whether to approve the request based on the reason.

I need to use this table
MaxComputeProjectNamestringYes

The name of the MaxCompute project in which you request permissions on the fields of a table.

aMaxcomputeProjectName
WorkspaceIdintegerYes

The ID of the DataWorks workspace that is associated with the MaxCompute project in which you want to request permissions on the fields of a table. You can go to the SettingCenter page in the DataWorks console to view the workspace ID.

12345
OrderTypeintegerNo

The type of the permission request order. The parameter value is 1 and cannot be changed. This value indicates ACL-based authorization.

1
EngineTypestringNo

The type of the compute engine in which you want to request permissions on the fields of a table. The parameter value is odps and cannot be changed. This value indicates that you can request permissions only on fields of tables in the MaxCompute compute engine.

odps
ApplyObjectarray<object>Yes

The objects on which you want to request permissions.

objectYes
ActionsstringYes

The permission that you want to request. If you want to request multiple permissions at the same time, separate them with commas (,). You can request only the following permissions: Select, Describe, Drop, Alter, Update, and Download.

Select,Describe
ColumnMetaListarray<object>Yes

The fields on which you want to request permissions.

objectNo
NamestringYes

The field on which you want to request permissions. If you want to request permissions on an entire table, enter all fields in the table. You can request permissions on specific fields of a table in a MaxCompute project only after LabelSecurity is enabled for this project. If LabelSecurity is disabled, you can request permissions only on an entire table.

aColumnName
NamestringYes

The name of the object on which you want to request permissions. You can request permissions only on MaxCompute tables. Set this parameter to the name of the table on which you want to request permissions.

aTableName

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

0bc1ec92159376****
FlowIdarray

The request order ID.

FlowIdstring

The request order ID. If you request permissions on multiple objects but each object has a different request approver, one request order is generated for each object and is sent to the related approver. In this case, an array is returned.

ee276e6e-5d34-46d8-b848-bca7879ed233

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bc1ec92159376****",
  "FlowId": [
    "ee276e6e-5d34-46d8-b848-bca7879ed233"
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-28The internal configuration of the API is changed, but the call is not affectedView Change Details