GetPermApplyOrderDetail - Data Management - Alibaba Cloud Documentation Center

Queries the details of a ticket that applies for permissions.

Operation description

You can call this operation to query the information about tickets that apply for permissions on databases, tables, and sensitive columns.

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetPermApplyOrderDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ticket ID. You can call the ListOrders operation to query the ticket ID.	730000
Tid	long	No	The tenant ID. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	-1

Response parameters

Parameter	Type	Description	Example
	object	The schema of response information.
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	A4C4499E-5AC2-4318-9FCF-03E426781A04
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
PermApplyOrderDetail	object	The details of the permission application ticket.
Resources	array<object>	The list of resources.
Resource	object	The information about the resource.
DatabaseInfo	object	The information about the database.
DbId	long	The database ID.	12345
Logic	boolean	Indicates whether the database is a logical database. Valid values: true false	false
DbType	string	The type of the database engine.	MySQL
SearchName	string	The name that is used to search for the database.	test@xxxx:3306【test】
OwnerIds	array	The IDs of the owners of the database.
OwnerId	long	The ID of the owner of the database.	12345
OwnerNickNames	array	The nicknames of the owners of the database.
OwnerNickName	string	The nickname of the owner of the database.	test_user
EnvType	string	The type of the environment to which the instance belongs. For more information, see Change the environment type of an instance.	product
TableInfo	object	The information about the table.
TableName	string	The name of the table.	test_tb
ColumnInfo	object	The information about the column.
TableName	string	The name of the table.	test_tb
ColumnName	string	The name of the column.	test_col
InstanceInfo	object	The information about the instance.
InstanceId	string	The ID of the instance.	12345
SearchName	string	The name that is used to search for the instance.	xxxx:3306
DbType	string	The type of the database engine.	MySQL
EnvType	string	The type of the environment to which the instance belongs. For more information, see Change the environment type of an instance.	product
Host	string	The endpoint of the instance.	xxxx
Port	long	The port that is used to connect to the instance.	3306
OwnerIds	array	The IDs of the owners of the instance.
OwnerId	long	The ID of the owner of the instance.	12345
OwnerNickName	array	The nicknames of the owners of the instance.
OwnerNickName	string	The nickname of the owner of the instance.	test_owner
DbaId	long	The ID of the database administrator (DBA) of the instance.	12345
DbaNickName	string	The nickname of the DBA of the instance.	test_dba
PermType	long	The type of the permissions that you apply for. Valid values: 1: the permissions to query information. 2: the permissions to export information. 3: the permissions to query and export information. 4: the permissions to modify information. 5: the permissions to query and modify information. 6: the permissions to export and modify information. 7: the permissions to query, export, and modify information. 8: the permissions to log on to the database.	7
Seconds	long	The validity duration of the permissions. Unit: seconds.	3600
ApplyType	string	The type of objects on which you apply for permissions. Valid values: DB: database TAB: table COL: column INSTANT: instance	DB

Examples

Sample success responses

JSONformat

{
  "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": 12345,
          "DbaNickName": "test_dba"
        }
      }
    ],
    "PermType": 7,
    "Seconds": 3600,
    "ApplyType": "DB"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history