Qin Ying, Fan 4a7d4f4cd8 DC API 0930 version

Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>

2022-10-06 09:33:01 +00:00

17 KiB

Raw Permalink Blame History

Creating an Endpoint Group

Function

This API is used to create a Direct Connect endpoint group.

URI

POST /v2.0/dcaas/dc-endpoint-groups

Request

Table 1 lists the request parameter.

**Table 1** Request parameter
Parameter	Type	Mandatory	Description
dc_endpoint_group	Dictionary data structure	Yes	Specifies the dc_endpoint_group object.

**Table 2** Description of field **dc_endpoint_group**
Parameter	Type	Mandatory	Description
tenant_id	String	Yes	Specifies the project ID.
name	String	No	Specifies the name of the Direct Connect endpoint group.
description	String	No	Provides supplementary information about the Direct Connect endpoint group.
endpoints	List<String>	Yes	Specifies the list of the endpoints in a Direct Connect endpoint group.
type	String	Yes	Specifies the type of the Direct Connect endpoints. The value can only be cidr.

Response

Table 3 lists the response parameter.

**Table 3** Response parameter
Parameter	Type	Description
dc_endpoint_group	Dictionary data structure	Specifies the dc_endpoint_group object.

**Table 4** Description of field **dc_endpoint_group**
Parameter	Type	Description
id	String	Specifies the ID of the Direct Connect endpoint group.
tenant_id	String	Specifies the project ID.
name	String	Specifies the name of the Direct Connect endpoint group.
description	String	Provides supplementary information about the Direct Connect endpoint group.
endpoints	List<String>	Specifies the list of the endpoints in a Direct Connect endpoint group.
type	String	Specifies the type of the Direct Connect endpoints. The value can only be cidr.

Examples

Example request

POST /v2.0/dcaas/dc-endpoint-groups
{  
     "dc_endpoint_group" : {
         "name" : "endpoint group1",
         "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],      
         "type" : "cidr"
     }
}

Example response

{  
     "dc_endpoint_group" : {
         "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
         "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
         "name" : "endpoint group1",
         "description" : "",
         "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],      
         "type" : "cidr"
    }
}

Returned Value

For details, see section Common Returned Values.

Parent topic: Direct Connect Endpoint Group

17 KiB Raw Permalink Blame History