Skip to main content

Update Role Module Permissions

Updates the module permission configuration of a specified role.

Request URL: /openapi/v1/role/module/update

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
roleIdStringYesRole ID. You can call List Roles to obtain it.2394
permissionListArrayNoList of module permissions. See permissionList Fields below.[{...}]

permissionList Fields

ParameterTypeRequiredDescriptionExample
actionStringYesModule permission action identifier. Please refer to action Values below.SQLEditor
accessBooleanYesWhether to grant the permission. true means grant and false means revoke.true

action Values

actionDisplay Name
SQLEditorSQL Editor
DSQLDSQL
SQLTaskSQL Task
SQLReviewSQL Review
DataImportData Import
DataExportData Export
DataArchiveData Archive
DataTrackData Tracking
SlowLogSlow Log Analysis
DataGenerateData Generation
BackupBackup
RestoreRestore
BackupSetBackup Set
BackupQueryBackup Data Query
ReplicationData Replication
DataCompareData Comparison
SchemaCompareSchema Comparison
DataSourceData Source
PolicyProcessProcess and Policy
SensitiveDataSensitive Data Management
MonitorO&M Monitoring
AuditAudit Log
DatabaseVersionDatabase Version Management
OpsTaskO&M Center Task Management
OpsClusterO&M Cluster Management
OpsNodeO&M Node Management
OpsPodO&M Pod Management

Request Example

{
"roleId": "2394",
"permissionList": [
{
"action": "SQLTask",
"access": true
},
{
"action": "DataExport",
"access": false
},
{
"action": "Monitor",
"access": true
}
]
}

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID.Nf5u0BQS-bhhhfLQnedcq0AGdeco3LPI

Successful Invocation Example

{
"success": true,
"requestId": "Nf5u0BQS-bhhhfLQnedcq0AGdeco3LPI"
}