addCloudMysqlUserList

Prev Next

Available in VPC

Add a DB user to a Cloud DB for MySQL instance.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET, POST /addCloudMysqlUserList

Request headers

For information about the headers common to all Cloud DB for MySQL (VPC) APIs, see Cloud DB for MySQL (VPC) request headers.

Request parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code
  • Region code of the Cloud DB for MySQL instance to add the DB user to
  • Check through getRegionList.
  • First Region of the getRegionList query result (default)
cloudMysqlInstanceNo String Required Instance number of Cloud DB for MySQL
cloudMysqlUserList.N.name List<String> Required User ID list to add to the Cloud DB for MySQL instance
  • 4 to 16 characters, including English letters, numbers, and special characters "-" and "_", and must begin with an English letter.
  • Predefined reserved words can't be used.
  • Example: cloudMysqlUserList.1.name=testuser1&cloudMysqlUserList.2.name=testuser2
cloudMysqlUserList.N.hostIp List<String> Required List of IP addresses to access MySQL Server
  • Allow access to all: %
  • Allow access to specific IPs (e.g., 1.1.1.1)
  • Allow access to an IP range (e.g., 1.1.1.%)
  • Allow CIDR (e.g., 1.1.1.0/24)
  • When using the GET method, % must be URL-encoded as %25.
cloudMysqlUserList.N.password List<String> Required DB user account password
  • Enter between 8 and 20 characters containing at least one English letter, number, and special character.
  • Special characters ` & + \ " ' / and spaces can't be used.
  • If the password plugin is activated, the policy set by the plugin must also be satisfied.
  • Example: cloudMysqlUserList.1.password=********&cloudMysqlUserList.2.password=********
cloudMysqlUserList.N.authority List<String> Required DB user permissions
  • READ | CRUD | DDL
    • READ: data query only
    • CRUD: data entry, query, modification, and change available
    • DDL: table creation, deletion, and change including the CRUD permission available
    • Example: cloudMysqlUserList.1.authority=DDL&cloudMysqlUserList.2.authority=DDL
cloudMysqlUserList.N.isSystemTableAccess Boolean Optional System table accessibility
  • true (default) | false
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/addCloudMysqlUserList
?regionCode=KR
&cloudMysqlInstanceNo=****890
&cloudMysqlUserList.1.name=testuser
&cloudMysqlUserList.1.hostIp=%
&cloudMysqlUserList.1.password=********
&cloudMysqlUserList.1.authority=DDL'
--header 'x-ncp-apigw-timestamp: {Timestamp}' 
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The response example is as follows:

  • If responseFormatType=json
{
    "addCloudMysqlUserListResponse": {
        "requestId": "902109aa-****-****-****-820b816e07b2",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • If responseFormatType=xml (default)
<?xml version="1.0" encoding="UTF-8"?>
<addCloudMysqlUserListResponse>
    <requestId>902109aa-****-****-****-820b816e07b2</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</addCloudMysqlUserListResponse>