查询发布订阅配置文件列表 - ListReplicationProfiles
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
rds:instance:update |
write |
- |
- |
rds:instance:modify |
- |
URI
- URI格式
GET /v3/{project_id}/instances/{instance_id}/replication/profiles?offset={offset}&limit={limit}&agent_type={agent_type}
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
非空。
取值范围：
不涉及。
默认取值：
不涉及。
offset
否
参数解释：
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。
约束限制：
不涉及。
取值范围：
必须为数字，不能为负数。
默认取值：
默认为0（偏移0条数据，表示从第一条数据开始查询）。
limit
否
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
1~100
默认取值：
10
agent_type
否
参数解释：
代理类型。
约束限制：
不涉及。
取值范围：
- snapshot：快照代理。
- log_reader：日志读取器代理。
- distribution：分发代理。
- merge：合并代理。
- queue_reader：队列读取器代理。
默认取值：
不涉及。
请求消息
响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
profiles
Array of objects
参数解释：
配置文件列表。
详情请参见表3。
total_count
Integer
参数解释：
配置文件总数。
取值范围：
不涉及。
表3 profiles元素结构说明 名称
参数类型
说明
profile_id
String
参数解释：
配置文件ID。
取值范围：
不涉及。
profile_name
String
参数解释：
配置文件名。
取值范围：
不涉及。
agent_type
String
参数解释：
代理类型。
取值范围：
- snapshot：快照代理。
- log_reader：日志读取器代理。
- distribution：分发代理。
- merge：合并代理。
- queue_reader：队列读取器代理。
description
String
参数解释：
配置文件说明。
取值范围：
不涉及。
is_def_profile
Boolean
参数解释：
是否为默认配置。
取值范围：
- true：是默认配置。
- false：不是默认配置。
- 正常响应样例
{ "profiles": [ { "profile_id": "2", "profile_name": "Default agent profile", "agent_type": "log_reader", "is_def_profile": true }, { "profile_id": "3", "profile_name": "Verbose history agent profile.", "agent_type": "log_reader", "description": "Agent profile for detailed history logging.", "is_def_profile": false } ], "total_count": 2 } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
