Querying Nodes for Delivering Key Views

Function

This API is used to obtain information about the nodes where key views can be delivered. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Constraints

This API is suitable only for nodes with CNs or DNs (primary or standby DNs).

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/instances/{instance_id}/key-view-execute-node

**Table 1** Parameter description
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 N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
nodes	Array of objects	Definition Node information list. For details, see Table 4.

**Table 4** NodeList
Parameter	Type	Description
node_id	String	Definition Node ID. Range N/A
node_name	String	Definition Node name. Range N/A
role	String	Definition Node role. Range master: primary node slave: standby node secondary: log node readreplica: read replica
type	String	Definition Component type. Range CN: CN component DN: DN component
distributed_id	String	Definition Distributed ID. Range N/A
component_id	String	Definition Component ID. Range N/A
detail	String	Definition Description. Range N/A

Example Request

Querying nodes for delivering key views

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/slow-sql-execute-node
{ 
}

Example Response

Nodes for delivering key views queried.

{
    "nodes": [
        {
            "node_id": "3e5ff444e79e4703b77be19d6d993612no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5dn1_0",
            "role": "master",
            "type": "DN",
            "distributed_id": "60011",
            "component_id": "dn_6001",
            "detail": "Normal"
        },
        {
            "node_id": "833cbc8183264518879c966c418cdd92no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5dn1_1",
            "role": "slave",
            "type": "DN",
            "distributed_id": "60011",
            "component_id": "dn_6002",
            "detail": "Normal"
        },
        {
            "node_id": "b2c08b95d3264f85b66afb1751110f56no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5dn1_2",
            "role": "slave",
            "type": "DN",
            "distributed_id": "60011",
            "component_id": "dn_6003",
            "detail": "Normal"
        },
        {
            "node_id": "3763acd115da4209a7348e68260d3236no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5cn_0",
            "role": "master",
            "type": "CN",
            "distributed_id": "",
            "component_id": "cn_5001",
            "detail": ""
        }
    ]
}