314 lines (172 loc) · 8.56 KB

\ServiceDiscoveryApi

All URIs are relative to http://127.0.0.1/v2

Method	HTTP request	Description
create_aws_region	POST /service_discovery/aws	Add a new AWS region
create_consul	POST /service_discovery/consul	Add a new Consul server
delete_aws_region	DELETE /service_discovery/aws/{id}	Delete an AWS region
delete_consul	DELETE /service_discovery/consul/{id}	Delete a Consul server
get_aws_region	GET /service_discovery/aws/{id}	Return an AWS region
get_aws_regions	GET /service_discovery/aws	Return an array of all configured AWS regions
get_consul	GET /service_discovery/consul/{id}	Return one Consul server
get_consuls	GET /service_discovery/consul	Return an array of all configured Consul servers
replace_aws_region	PUT /service_discovery/aws/{id}	Replace an AWS region
replace_consul	PUT /service_discovery/consul/{id}	Replace a Consul server

create_aws_region

crate::models::AwsRegion create_aws_region(aws_region) Add a new AWS region

Add a new AWS region. Credentials are not required in case Dataplane API is running in an EC2 instance with proper IAM role attached.

Parameters

Name	Type	Description	Required	Notes
aws_region	AwsRegion		[required]

Return type

crate::models::AwsRegion

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_consul

crate::models::Consul create_consul(consul) Add a new Consul server

Adds a new Consul server.

Parameters

Name	Type	Description	Required	Notes
consul	Consul		[required]

Return type

crate::models::Consul

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_aws_region

delete_aws_region(id) Delete an AWS region

Delete an AWS region configuration by it's id.

Parameters

Name	Type	Description	Required	Notes
id	String	AWS region ID	[required]

Return type

(empty response body)

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_consul

delete_consul(id) Delete a Consul server

Deletes a Consul server configuration by it's id.

Parameters

Name	Type	Description	Required	Notes
id	String	Consul server Index	[required]

Return type

(empty response body)

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_aws_region

crate::models::GetAwsRegion200Response get_aws_region(id) Return an AWS region

Return one AWS Region configuration by it's id.

Parameters

Name	Type	Description	Required	Notes
id	String	AWS region id	[required]

Return type

crate::models::GetAwsRegion200Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_aws_regions

crate::models::GetAwsRegions200Response get_aws_regions() Return an array of all configured AWS regions

Return all configured AWS regions.

Parameters

This endpoint does not need any parameter.

Return type

crate::models::GetAwsRegions200Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_consul

crate::models::GetConsul200Response get_consul(id) Return one Consul server

Returns one Consul server configuration by it's id.

Parameters

Name	Type	Description	Required	Notes
id	String	Consul server id	[required]

Return type

crate::models::GetConsul200Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_consuls

crate::models::GetConsuls200Response get_consuls() Return an array of all configured Consul servers

Returns all configured Consul servers.

Parameters

This endpoint does not need any parameter.

Return type

crate::models::GetConsuls200Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_aws_region

crate::models::AwsRegion replace_aws_region(id, aws_region) Replace an AWS region

Replace an AWS region configuration by its id.

Parameters

Name	Type	Description	Required	Notes
id	String	AWS Region ID	[required]
aws_region	AwsRegion		[required]

Return type

crate::models::AwsRegion

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_consul

crate::models::Consul replace_consul(id, consul) Replace a Consul server

Replaces a Consul server configuration by it's id.

Parameters

Name	Type	Description	Required	Notes
id	String	Consul Index	[required]
consul	Consul		[required]

Return type

crate::models::Consul

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]