All Products
Search
Document Center

Data Management:GetPermApplyOrderDetail

Last Updated:Sep 15, 2023

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.

debugging

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetPermApplyOrderDetailRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ticket ID. You can call the ListOrders operation to query the ticket ID.

730000
TidlongNo

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

ParameterTypeDescriptionExample
object

The schema of response information.

RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

A4C4499E-5AC2-4318-9FCF-03E426781A04
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
PermApplyOrderDetailobject

The details of the permission application ticket.

Resourcesobject []

The list of resources.

DatabaseInfoobject

The information about the database.

DbIdlong

The database ID.

12345
Logicboolean

Indicates whether the database is a logical database. Valid values:

  • true
  • false
false
DbTypestring

The type of the database engine.

MySQL
SearchNamestring

The name that is used to search for the database.

test@xxxx:3306【test】
OwnerIdsarray

The IDs of the owners of the database.

long

The ID of the owner of the database.

12345
OwnerNickNamesarray

The nicknames of the owners of the database.

string

The nickname of the owner of the database.

test_user
EnvTypestring

The type of the environment to which the instance belongs. For more information, see Change the environment type of an instance.

product
TableInfoobject

The information about the table.

TableNamestring

The name of the table.

test_tb
ColumnInfoobject

The information about the column.

TableNamestring

The name of the table.

test_tb
ColumnNamestring

The name of the column.

test_col
InstanceInfoobject

The information about the instance.

InstanceIdstring

The ID of the instance.

12345
SearchNamestring

The name that is used to search for the instance.

xxxx:3306
DbTypestring

The type of the database engine.

MySQL
EnvTypestring

The type of the environment to which the instance belongs. For more information, see Change the environment type of an instance.

product
Hoststring

The endpoint of the instance.

xxxx
Portlong

The port that is used to connect to the instance.

3306
OwnerIdsarray

The IDs of the owners of the instance.

long

The ID of the owner of the instance.

12345
OwnerNickNamearray

The nicknames of the owners of the instance.

string

The nickname of the owner of the instance.

test_owner
DbaIdlong

The ID of the database administrator (DBA) of the instance.

12345
DbaNickNamestring

The nickname of the DBA of the instance.

test_dba
PermTypelong

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
Secondslong

The validity duration of the permissions. Unit: seconds.

3600
ApplyTypestring

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 timeSummary of changesOperation
No change history