All Products
Search

This Product

    PolarDB:ModifyDBEndpointAddress

    Document Center

    PolarDB:ModifyDBEndpointAddress

    Last Updated:Jun 17, 2024

    Modifies the endpoints of a PolarDB cluster, including the primary endpoint, default cluster endpoint, custom cluster endpoint, and private domain name.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    polardb:ModifyDBEndpointAddressWrite
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of cluster.

    Note You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.
    		pc-***************
    DBEndpointIdstringYes

    The ID of the endpoint.

    Note You can call the DescribeDBClusterEndpoints operation to query endpoint IDs.
    		pe-****************
    NetTypestringYes

    The network type of the endpoint. Valid values:

    • Public
    • Private
    		Public
    ConnectionStringPrefixstringNo

    The prefix of the new endpoint. The prefix must meet the following requirements:

    • It can contain lowercase letters, digits, and hyphens (-).
    • It must start with a letter and end with a digit or a letter.
    • It must be 6 to 30 characters in length.
    		example
    PrivateZoneAddressPrefixstringNo

    The prefix of the private domain name. The prefix must meet the following requirements:

    • The prefix can contain lowercase letters, digits, and hyphens (-).
    • The prefix must start with a letter and end with a digit or a letter.
    • The prefix must be 6 to 30 characters in length.
    Note
  • You can bind each internal endpoint of PolarDB to a private domain name. The private domain name takes effect only in the specified virtual private clouds (VPCs) in the current region. Private domain names are managed by using PrivateZone. You can use the CNAME record of PrivateZone to map domain names to PolarDB. You are charged a small fee for this feature. For more information, see Pricing .
  • This parameter takes effect only if you set NetType to Private.
    •
    		aliyundoc
    PrivateZoneNamestringNo

    The name of the private zone.

    Note This parameter takes effect only when NetType is set to Private.
    		aliyundoc.com
    PortstringNo

    The port number. Valid values: 3000 to 5999.

    Note This parameter is valid only for PolarDB for MySQL clusters. If you leave this parameter empty, the default port 3306 is used.
    		3306

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		D0CEC6AC-7760-409A-A0D5-E6CD86******

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

    Error codes

    HTTP status codeError codeError messageDescription
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-12-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
      Added Error Codes: 400