Skip to main content

Query Roles with Target Data Source Permissions

Specify a data source to view all roles that have permissions for that data source.

Request URL: /openapi/v1/role/datasource/list

Request Method: GET

Request Parameters

ParameterTypeRequiredDescriptionExample
datasourceIdStringYesData source ID.ds-abc123
actionStringYesPermission name. Options:
  • Readonly: Read-only permission.
  • DML: DML permission.
  • DDL: DDL permission.
  • SQLTask: Submit SQL task permission.
  • SQLTaskExecute: Execute SQL task permission.
  • DataGenerate: Submit data generation task permission.
  • DataImport: Submit data import task permission.
  • DataImportExecute: Execute data import task permission.
  • DataExport: Submit data export task permission.
  • DataExportExecute: Execute data export task permission.
  • DataArchive: Data archiving permission.
  • DataTrack: Data tracking permission.
  • Backup: Data backup permission.
  • Restore: Data restore permission.
  • Replication: Data replication permission.
  • DataCompare: Data comparison permission.
  • SchemaCompare: Schema comparison permission.
  • Management: Data source management permission.
  • DatabaseVersion: Database version management permission.
Readonly
currentIntegerNoCurrent page number.1
pageSizeIntegerNoPage size.10

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request was successful.true
requestIdStringRequest ID.Mi6y0FCN-BHEEaHAnCFFp9DFdAAk0OUZ
dataArrayRole list, including the following fields:
  • name: Role name.
  • roleId: Role ID.
  • type: Role type (system: System administrator, custom: Regular role).
{
"roleId": "16",
"name": "System Administrator",
"type": "system"
}, {
"roleId": "40",
"name": "Production Environment Administrator",
"type": "custom"
}
currentIntegerCurrent page number.1
pageSizeIntegerPage size.10
totalIntegerTotal number of records.2

Successful Invocation Example

{
"success": true,
"requestId": "Fg1p1HNO-cigfjUOnhfdn3ZOddjy1CAI",
"data": [{
"roleId": "16",
"name": "System Administrator",
"type": "system"
}, {
"roleId": "40",
"name": "Production Environment Administrator",
"type": "custom"
}],
"current": 1,
"pageSize": 10,
"total": 2
}