From c4560315609aee78e41fd9c216c232039c7fcfd8 Mon Sep 17 00:00:00 2001 From: "Ru, Li Yi" Date: Fri, 6 Dec 2024 09:06:15 +0000 Subject: [PATCH] dds_api_20241115 Reviewed-by: Boka, Ladislav Co-authored-by: Ru, Li Yi Co-committed-by: Ru, Li Yi --- docs/dds/api-ref/dds_api_0120.html | 42 +++++++++++++++--------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/dds/api-ref/dds_api_0120.html b/docs/dds/api-ref/dds_api_0120.html index 7796fb13..2cce2d61 100644 --- a/docs/dds/api-ref/dds_api_0120.html +++ b/docs/dds/api-ref/dds_api_0120.html @@ -35,47 +35,47 @@

Requests

  • Parameter description -
    Table 2 Parameter description

    Name

    +
    - - - - - - - - - - - - - - -
    Table 2 Parameter description

    Name

    Mandatory

    +

    Type

    Type

    +

    Mandatory

    Description

    +

    Description

    type

    +

    type

    Yes

    +

    String

    String

    +

    Yes

    Specifies the type of the object for which the IP address is to be enabled.

    -
    • To enable IP addresses for shard nodes, set the value to shard.
    • To enable IP addresses for config nodes, set the value to config.
    +

    Cluster instance type.

    +
    • When applying for a shard IP address, set the value to shard. A read-only user sharduser is automatically created for the shard group. (Each shard group has a read-only user with the same name.)
    +
    • When applying for a config IP address, set the value to config. A read-only user csuser is automatically created for the config group.

    target_id

    +

    target_id

    No

    +

    String

    String

    +

    No

    Specifies the ID of the group whose IP addresses are to be enabled.

    -
    • For shard nodes, the value is the shard ID.
    • For config nodes, the value is the config ID.
    • If this parameter is left blank, enable all IP addresses of the same node type in the instance.
    -
    CAUTION:
    • If the IP address is enabled for the first time, leave this parameter empty.
    • If the IP address is enabled, this parameter cannot be delivered repeatedly.
    +

    Shard group ID.

    +
    CAUTION:
    • If you apply for a shard or config IP address for the first time, this parameter is not specified. You can apply for an IP address for all shard groups using the same password and create a read-only user sharduser.
    • In node scale-out scenarios, the system does not automatically apply for an IP address and read-only user sharduser for the new shard group because there is no sharduser user and password of other shard groups. If you need to apply for an IP address for the new shard group, call this API and specify target_id (group ID).
    • If this API is called for multiple times for the same DB instance, the values for the password field can be different. (Each shard group has a read-only user with the same name.)

    password

    +

    password

    Yes

    +

    String

    String

    +

    Yes

    Specifies the password for enabling this function for a cluster.

    -
    • The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?
    • Enter a strong password to improve security, preventing security risks such as brute force cracking.
    -
    CAUTION:

    This password cannot be changed. Exercise caution when performing this operation.

    +

    The password for enabling this function for a cluster.

    +
    • The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?()$
    • Enter a strong password to improve security, preventing security risks such as brute force cracking.
    +
    CAUTION:

    The password can be changed by calling the API for changing a database user password. After the API for changing a database user password is called, the passwords of the read-only user sharduser of all shard groups are the same when target_id is specified.