GetPermApplyOrderDetail - query permission request ticket details - Data Management

Queries the details of a permission application ticket.

Operation description

This operation applies to database-permission, table-permission, and sensitive column-permission.

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

dms:GetPermApplyOrderDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ticket ID. You can call the ListOrders operation to query the ticket ID.	73****
Tid	integer	No	The tenant ID. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the DMS console. View information about the current tenant.	3***

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	A4C4499E-5AC2-4318-9FCF-03E426781A04
Success	boolean	Whether the request succeeded. Valid values: true false	true
ErrorMessage	string	The error message if the request failed.	UnknownError
ErrorCode	string	The error code if the request failed.	UnknownError
PermApplyOrderDetail	object	The permission application ticket details.
Resources	array<object>	The list of resources.
	array<object>	Resource details.
DatabaseInfo	object	Database details.
DbId	integer	The database ID.	12345
Logic	boolean	Whether the database is logical. Valid values: true false	false
DbType	string	The database engine type.	MySQL
SearchName	string	The search name of the database.	test@xxxx:3306[test]
OwnerIds	array	The database owner IDs.
	integer	The database owner ID.	12345
OwnerNickNames	array	The database owner nicknames.
	string	The database owner nickname.	test_user
EnvType	string	The environment type of the instance. Change the environment type of an instance.	product
TableInfo	object	Table details.
TableName	string	The name of the table.	test_tb
ColumnInfo	object	Column details.
TableName	string	The name of the table.	test_tb
ColumnName	string	The name of the column.	test_col
InstanceInfo	object	Instance details.
InstanceId	string	The ID of the instance.	12345
SearchName	string	The search name of the instance.	xxxx:3306
DbType	string	The database engine type.	MySQL
EnvType	string	The environment type of the instance. Change the environment type of an instance.	product
Host	string	The endpoint of the instance.	xxxx
Port	integer	The connection port of the instance.	3306
OwnerIds	array	The instance owner IDs.
	integer	The instance owner ID.	12345
OwnerNickName	array	The instance owner nicknames.
	string	The instance owner nickname.	test_owner
DbaId	integer	The DBA ID of the instance.	123****
DbaNickName	string	The DBA nickname of the instance.	test_dba
RowInfo	object	Row-level permission details.
DbId	integer	The database ID. Databases are physical or logical: Physical database ID: call ListDatabases or SearchDatabase to obtain this value. Logical database ID: call ListLogicDatabases or SearchDatabase to obtain this value.	69256456
Logic	boolean	Whether the database is logical. Valid values: true: Yes false: No	false
SchemaName	string	Database name.	testdb003
TableName	string	Table name.	ods_qr_dms_vehicleorder_df
ColumnName	string	Field name.	xrxs_xid
MatchMode	string	Matching mode. Valid values: EQ: exact match LIKE: fuzzy matching	EQ
RowGroupId	integer	Row control group ID.	123434
RowValueInfo	object	Row value details.
RowValue	string	Row value.	test_value
PermType	integer	The permission type. Valid values: 1: query. 2: export. 3: query and export. 4: modify. 5: query and modify. 6: export and modify. 7: query, export, and modify. 8: database logon.	7
Seconds	integer	The permission validity duration, in seconds.	3600
ApplyType	string	The object type for the permission application. Valid values: DB: database TAB: table COL: column INSTANT: instance	DB

Examples

Success response

JSON format

{
  "RequestId": "A4C4499E-5AC2-4318-9FCF-03E426781A04",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "PermApplyOrderDetail": {
    "Resources": [
      {
        "DatabaseInfo": {
          "DbId": 12345,
          "Logic": false,
          "DbType": "MySQL",
          "SearchName": "test@xxxx:3306[test]",
          "OwnerIds": [
            12345
          ],
          "OwnerNickNames": [
            "test_user"
          ],
          "EnvType": "product"
        },
        "TableInfo": {
          "TableName": "test_tb"
        },
        "ColumnInfo": {
          "TableName": "test_tb",
          "ColumnName": "test_col"
        },
        "InstanceInfo": {
          "InstanceId": "12345",
          "SearchName": "xxxx:3306",
          "DbType": "MySQL",
          "EnvType": "product",
          "Host": "xxxx",
          "Port": 3306,
          "OwnerIds": [
            12345
          ],
          "OwnerNickName": [
            "test_owner"
          ],
          "DbaId": 0,
          "DbaNickName": "test_dba"
        },
        "RowInfo": {
          "DbId": 69256456,
          "Logic": false,
          "SchemaName": "testdb003",
          "TableName": "ods_qr_dms_vehicleorder_df",
          "ColumnName": "xrxs_xid",
          "MatchMode": "EQ",
          "RowGroupId": 123434
        },
        "RowValueInfo": {
          "RowValue": "test_value"
        }
      }
    ],
    "PermType": 7,
    "Seconds": 3600,
    "ApplyType": "DB"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.