DescribeDBEndpoint--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeDBEndpoint

最近更新时间：2024.11.08 10:14:36首次发布时间：2023.09.27 10:12:30

调用 DescribeDBEndpoint 接口查询指定 veDB MySQL 实例连接终端的详细信息。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-2pf2xk5v****	实例 ID。
EndpointId	String	否	vedbm-2pf2xk5v****-Custom-50yv	连接终端 ID。

返回参数

名称	类型	示例值	描述
Total	Integer	2	连接终端总数。
Endpoints	Array of EndpointObject	请参见返回示例。	连接终端的详细信息。更多关于 Endpoints 的信息，请参见 EndpointObject。

请求示例

POST /?Action=DescribeDBEndpoint&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20230828T084117Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkOD******/20230828/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c87******

{
    "InstanceId":"vedbm-53vb4ido****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230828164117A453591E8C1EBE492369",
        "Action": "DescribeDBEndpoint",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "Endpoints": [
            {
                "Addresses": [
                    {
                        "DNSVisibility": false,
                        "Domain": "vedbm-53vb4ido****.pri.mysql.vedb.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.120",
                        "NetworkType": "Private",
                        "Port": "3306",
                        "SubnetId": "subnet-3jhizp4kh5r0g3pncmfdh****"
                    }
                ],
                "AutoAddNewNodes": false,
                "ConsistLevel": "Global",
                "ConsistTimeout": 0,
                "ConsistTimeoutAction": "ReadMaster",
                "Description": "主节点终端",
                "DistributedTransaction": false,
                "EndpointId": "vedbm-53vb4ido****-Primary",
                "EndpointName": "主节点终端",
                "EndpointType": "Primary",
                "MasterAcceptReadRequests": true,
                "NodeIds": [
                    "vedbm-53vb4ido****-1"
                ],
                "ReadWriteMode": "ReadWrite"
            },
            {
                "Addresses": [
                    {
                        "DNSVisibility": false,
                        "Domain": "vedbm-53vb4ido****.default.mysql.vedb.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.80",
                        "NetworkType": "Private",
                        "Port": "3306",
                        "SubnetId": "subnet-3jhizp4kh5r0g3pncmfdh****"
                    }
                ],
                "AutoAddNewNodes": true,
                "ConsistLevel": "Session",
                "ConsistTimeout": 20000,
                "ConsistTimeoutAction": "ReadMaster",
                "Description": "默认终端",
                "DistributedTransaction": true,
                "EndpointId": "vedbm-53vb4ido****-ReadWriteSplit",
                "EndpointName": "默认终端",
                "EndpointType": "Cluster",
                "MasterAcceptReadRequests": true,
                "NodeIds": [
                    "vedbm-53vb4ido****-2",
                    "vedbm-53vb4ido****-1"
                ],
                "ReadWriteMode": "ReadWrite"
            },
            {
                "Addresses": [
                    {
                        "DNSVisibility": false,
                        "Domain": "vedbm-53vb4ido****.custom-mwn8.mysql.vedb.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.175",
                        "NetworkType": "Private",
                        "Port": "3306",
                        "SubnetId": "subnet-3jhizp4kh5r0g3pncmfdh****"
                    }
                ],
                "AutoAddNewNodes": true,
                "ConsistLevel": "Session",
                "ConsistTimeout": 10000,
                "ConsistTimeoutAction": "ReadMaster",
                "Description": "",
                "DistributedTransaction": false,
                "EndpointId": "vedbm-53vb4ido****-Custom-mwn8",
                "EndpointName": "自定义终端",
                "EndpointType": "Custom",
                "MasterAcceptReadRequests": true,
                "NodeIds": [
                    "vedbm-53vb4ido****-0",
                    "vedbm-53vb4ido****-2",
                    "vedbm-53vb4ido****-1"
                ],
                "ReadWriteMode": "ReadWrite"
            }
        ],
        "Total": 3
    }
}

错误码

更多详情，请参见错误码。