doc-exports/docs/ddm/api-ref/en-us_topic_0000002332909529.html

Creating a DDM Instance (a V3 API)

Function

This API is used to create a DDM instance.

Constraints

DDM runs in VPCs. Before you create a DDM instance, ensure that a VPC is available and a subnet and security group have been configured.

URI

POST /v3/{project_id}/instances

Table 1 Path parameter

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by calling the IAM API used to obtain a user token.
Content-Type	Yes	String	MIME type of the request body. Value range: application/json application/json;charset=utf-8

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
name	Yes	String	Name of a DDM instance, which: Can include 4 to 64 characters. Must start with a letter. Can contain only letters, digits, underscores (_), and hyphens (-). Minimum length: 4 characters Maximum length: 64 characters
flavor_ref	Yes	String	Node class ID. It can be obtained by referring to Querying DDM Node Classes Available in Each AZ (a V3 API).
node_num	Yes	Integer	Number of nodes
engine_version	Yes	String	Engine version (core instance version) It can be obtained by referring to Querying DDM Engine Information (a V3 API).
available_zones	Yes	Array of strings	AZ code. The value cannot be empty. For details, see Regions and Endpoints.
vpc_id	Yes	String	VPC ID
security_group_id	Yes	String	Security group ID
subnet_id	Yes	String	Subnet ID
param_group_id	No	String	Parameter group ID
time_zone	No	String	UTC time zone. The default value is UTC. The value can be UTC, UTC-12:00, UTC-11:00, UTC-10:00, UTC-09:00, UTC-08:00, UTC-07:00, UTC-06:00, UTC-05:00, UTC-04:00, UTC-03:00, UTC-02:00, UTC-01:00, UTC+01:00, UTC+02:00, UTC+03:00, UTC+04:00, UTC+05:00, UTC+06:00, UTC+07:00, UTC+08:00, UTC+09:00, UTC+10:00, UTC+11:00, and UTC+12:00.

Example Request

• Creating a DDM instance.

  POST https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances
  {
    "name": "test-ddm",
    "flavor_ref": "ddm.xlarge.4",
    "node_num": 1,
    "engine_version": "3.1.7.0",
    
    "available_zones": [
      "eu-de-01"
    ],
    "vpc_id": "f6509a58-51bc-4454-a3e7-6ec7e97xx",
    "security_group_id": "16cfe4b3-905c-44b8-a29d-e51d8b03c6dc",
    "subnet_id": "22774dc2-abe8-4435-85b1-c9b997518a5d",
    "param_group_id": "527818581bee4283ac14cc1e9b457072pr09",
    "time_zone": "UTC",
    "admin_user_name": "root",
    "admin_user_password": "PassWord_234"
  }

Response

• Normal response

  Table 4 Response body parameters

  Parameter	Type	Description
  id	String	Instance ID.
  job_id	String	ID of the job for creating an instance. This parameter is returned only when pay-per-use instances are created.

• Normal response example

  {
    "id": "e90bc6739a3c4666a577c3fa1524dac2in09", 
    "job_id": "3ae783f3-844e-4051-abd5-b9cc65899785",
   }

• Abnormal response

  For details, see Abnormal Request Results.

Status Codes

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: DDM Instances