Huijuan, Wang 7d71165909 ecs api 20240912

Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>

2024-10-24 12:45:08 +00:00

18 KiB

Raw Blame History

Creating an ECS Group

Function

This API is used to create an ECS group.

Constraints

Only anti-affinity groups are supported.

URI

POST /v2.1/{project_id}/os-server-groups

POST /v2/{project_id}/os-server-groups

Table 1 describes the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID.

Request

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
server_group	Yes	Object	Specifies the ECS group information. For details, see Table 3.

**Table 3** **server_group** field description
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the ECS group name. The value contains 1 to 255 characters.
policies	Yes	Array of strings	Specifies the policies associated with the ECS group. Options: anti-affinity: ECSs in this group must be deployed on different hosts. NOTE: You are suggested to use the policy described in Creating an ECS Group.

Response

Table 4 describes the response parameters.

**Table 4** Response parameters
Parameter	Type	Description
server_group	Object	Specifies the ECS group information. For details, see Table 5.

**Table 5** **server_group** field description
Parameter	Type	Description
id	String	Specifies the ECS group UUID.
name	String	Specifies the ECS group name.
policies	Array of strings	Specifies the policies associated with the ECS group. Options: anti-affinity: ECSs in this group must be deployed on different hosts.
members	Array of strings	Specifies the ECSs contained in an ECS group.
metadata	Object	Specifies the ECS group metadata.
project_id	String	Specifies the tenant ID in UUID format for the ECS group. This parameter is supported in microversion 2.13 and later.
user_id	String	Specifies the user ID in UUID format for the ECS group. This parameter is supported in microversion 2.13 and later.

Example Request

Create an ECS group.

POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups

{
    "server_group": {
        "name": "test",
        "policies": ["anti-affinity"]
    }
}

Example Response

{
    "server_group": {
        "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
        "name": "test",
        "policies": [
            "anti-affinity"
        ],
        "members": [],
        "metadata": {}
    }
}

Returned Values

See Returned Values for General Requests.

Parent topic: ECS Group Management

18 KiB Raw Blame History