ReleaseNodePrivateNetworkAddress

Updated at: 2024-09-03 02:51

Releases the internal endpoint of a shard or Configserver node in a sharded cluster instance.

Operation description

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
OperationAccess levelResource typeCondition keyAssociated operation
dds:ReleaseNodePrivateNetworkAddressupdate
  • Instance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the sharded cluster instance.

dds-bp1a7009eb24****
NodeIdstringYes

The ID of the shard or Configserver node.

Note
You can call the DescribeDBInstanceAttribute operation to query the ID of the shard or Configserver node.
d-bp128a003436****
NetworkTypestringNo

The network type of the internal endpoint. Valid values:

  • VPC: virtual private cloud (VPC).
  • Classic: classic network.
Note
You can call the DescribeShardingNetworkAddress operation to query the network type of the internal endpoint.
VPC
ConnectionTypestringNo

The public endpoint type. Valid values:

  • SRV
  • Normal
Note
This parameter is valid only when you want to release an SRV endpoint.
SRV

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object

The information of the request.

RequestIdstring

The request ID.

0FDDC511-7252-4A4A-ADDA-5CB1BF63873D

Examples

Sample success responses

JSONformat

{
  "RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63873D"
}

Error codes

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2024-03-14The request parameters of the API has changedView Change Details
2023-10-17The request parameters of the API has changedView Change Details
2023-10-17The request parameters of the API has changedView Change Details
  • On this page (1)
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us