Skip to main content

Query Data Source Permissions for a Role

Query the data source permissions owned by a specified role, including environment, data source, and permission operations.

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

Request Method: GET

Request Parameters

ParameterTypeRequiredDescriptionExample
roleIdStringYesRole ID. You can call the Get Role Information interface to obtain roleId.16

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID.Mi6y0FCN-BHEEaHAnCFFp9DFdAAk0OUZ
dataArrayList of data source permission groups, including the following fields:
  • groupId: Data source group ID.
  • envList: Environment list.
    • envId: Environment ID.
    • name: Environment name.
    • color: Identification color.
    • background: Background color.
  • datasourceList: Data source list.
    • datasourceId: Data source ID.
    • name: Data source name.
  • permissionList: Permission list.
    • 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 restoration permission.
    • Replication: Data replication permission.
    • DataCompare: Data comparison permission.
    • SchemaCompare: Schema comparison permission.
    • Management: Data source management permission.
    • DatabaseVersion: Database version management permission.
{
"groupId": "admindsg-cn79v9px9r3t",
"envList": [{
"envId": "env-product",
"name": "nd.basic.datasource.environment.product"
}, {
"envId": "env-dev",
"name": "nd.basic.datasource.environment.dev"
}],
"datasourceList": [],
"permissionList": ["Readonly", "DML", "DDL", "SQLTask", "SQLTaskExecute", "DataGenerate", "DataImport", "DataImportExecute", "DataExport", "DataExportExecute", "Backup", "Restore", "Replication", "DataCompare", "SchemaCompare", "Management"]
}

Successful Invocation Example

{
"success": true,
"requestId": "Sx7u0TSU-bhfehNQngdjy9XSdcfi7LYG",
"data": [{
"groupId": "admindsg-cn79v9px9r3t",
"envList": [{
"envId": "env-product",
"name": "nd.basic.datasource.environment.product"
}, {
"envId": "env-dev",
"name": "nd.basic.datasource.environment.dev"
}],
"datasourceList": [],
"permissionList": ["Readonly", "DML", "DDL", "SQLTask", "SQLTaskExecute", "DataGenerate", "DataImport", "DataImportExecute", "DataExport", "DataExportExecute", "Backup", "Restore", "Replication", "DataCompare", "SchemaCompare", "Management"]
}]
}