文档首页/数据复制服务 DRS/API参考/API v5（公测中）/权限管理/查询委托的权限列表 - ListsAgencyPermissions
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询委托的权限列表 - ListsAgencyPermissions

功能介绍

根据源库类型，目标库类型，是否自建，获取委托所需要的权限。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/agency/permissions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

source_type

否

String

源库类型。

  • mysql：MySQL
  • sqlserver：Microsoft SQL Server
  • postgresql：PostgreSQL
  • mongodb：MongoDB、DDS
  • oracle：Oracle
  • taurus：TaurusDB
  • ddm：DDM
  • kafka：Kafka
  • gaussdbv5：GaussDB分布式版
  • gaussdbv5ha：GaussDB集中式版
  • gaussmongodb：GeminiDB Mongo
  • db2：DB2
  • tidb：TiDB
  • redis：Redis
  • rediscluster：Redis集群
  • gaussredis：GeminiDB Redis
  • mariadb：MariaDB
  • informix：Informix
  • dynamo：Dynamo

target_type

否

String

目标库类型。

  • mysql：MySQL
  • sqlserver：Microsoft SQL Server
  • postgresql：PostgreSQL
  • mongodb：MongoDB、DDS
  • oracle：Oracle
  • taurus：TaurusDB
  • ddm：DDM
  • kafka：Kafka
  • gaussdbv5：GaussDB分布式版
  • gaussdbv5ha：GaussDB集中式版
  • gaussmongodb：GeminiDB Mongo
  • db2：DB2
  • tidb：TiDB
  • redis：Redis
  • rediscluster：Redis集群
  • gaussredis：GeminiDB Redis
  • mariadb：MariaDB
  • informix：Informix
  • dynamo：Dynamo

is_non_dbs

是

Boolean

是否自建。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

common_permissions

Array of strings

  • DRS FullAccess：数据复制服务所有权限

engine_permissions

Array of strings

  • GaussDB ReadOnlyAccess：云数据库 GaussDB服务的只读访问权限。
  • GeminiDB ReadOnlyAccess：分布式多模NoSQL数据库服务只读权限。
  • DDM ReadOnlyAccess：分布式数据库中间件服务只读权限。
  • DDS ReadOnlyPolicy：文档数据库服务资源只读权限。
  • RDS ReadOnlyAccess：关系型数据库服务资源只读权限。
  • MRS ReadOnlyAccess：MapReduce服务只读权限，包括集群查询操作、基础服务弹性云服务器、裸金属服务器、云硬盘、虚拟私有云只读权限。

请求示例

根据源库类型，目标库类型，是否自建，获取委托所需要的权限

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/agency/permissions?source_type=mysql&target_type=taurus&non_dbs=false

响应示例

状态码：200

{
"common_permissions": [
    "DRS FullAccess",
  ],
  "engine_permissions": [
    "RDS ReadOnlyAccess",
    "GaussDBforMSQLReadOnlyAccess"
  ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：权限管理

相关文档