ModifyDBEndpointAddress--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

ModifyDBEndpointAddress

最近更新时间：2024.12.13 12:00:10首次发布时间：2023.11.15 22:39:52

调用 ModifyDBEndpointAddress 接口修改实例私网连接地址的端口和前缀。

请求类型

同步请求。

注意事项

在一次调用中不能同时修改私网连接地址的前缀和端口，只能对其中一项进行修改。不能同时不为请求参数 DomainPrefix 和 Port 传值，也不可同时为两者传值。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-21a3333b****	实例 ID。
EndpointId	String	否	postgres-ca7b7019****-custom-f07b	待修改连接地址的连接终端 ID。如不设定，默认选择默认终端。
NetworkType	String	是	Private	网络类型，目前仅支持 `Private`。
DomainPrefix	String	否	postgresc602d39c****	新的访问地址前缀。访问地址前缀应满足以下规则：由小写字母、数字和中划线（-）组成。至少包含 8 个字符，总长度（含后缀）不得超过 63 个字符。以小写字母开头，以小写字母或数字结尾。
Port	String	否	5432	端口的端口号。取值范围为 1000~65534。

返回参数

null

示例

请求示例

POST /?Action=ModifyDBEndpointAddress&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: open.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "postgres-ca7b7019****",
    "EndpointId": "postgres-ca7b7019****-custom-f07b",
    "NetworkType": "Private",
    "DomainPrefix": "newdomainprefix",
    "Port": "5432"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308021628147ED0667023AE84FD018B",
        "Action": "ModifyDBEndpointAddress",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": null
}