Querying Publication and Subscription Profiles of a DB Instance

Function

This API is used to query publication and subscription profiles of a DB instance.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:update	write	-	-	rds:instance:modify	-

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/replication/profiles?offset={offset}&limit={limit}&agent_type={agent_type}

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints The value cannot be empty. Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range N/A Default Value N/A
offset	No	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints N/A Range The value must be a non-negative number. Default Value 0: The query starts from the first data record.
limit	No	Definition Number of records returned by a query. Constraints N/A Range 1–100 Default Value 10
agent_type	No	Definition Agent type. Constraints N/A Range snapshot: snapshot agent log_reader: log reader agent distribution: distribution agent merge: merge agent queue_reader: queue reader agent Default Value N/A

Request

Request parameters
None
URI example
GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/profiles?offset=0&limit=10&agent_type=log_reader

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
profiles	Array of objects	Definition List of profiles. For details, see Table 3.
total_count	Integer	Definition Total number of profiles. Range N/A

**Table 3** profiles element structure description
Parameter	Type	Description
profile_id	String	Definition Profile ID. Range N/A
profile_name	String	Definition Profile name. Range N/A
agent_type	String	Definition Agent type. Range snapshot: snapshot agent log_reader: log reader agent distribution: distribution agent merge: merge agent queue_reader: queue reader agent
description	String	Definition Profile description. Range N/A
is_def_profile	Boolean	Definition Whether the profile is the default one. Range true: The profile is the default one. false: The profile is not the default one.

Example normal response

{
    "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
}