| Required role: | TenantReader | Requires the role: | Workflow |
| GET | /api/resourceaddons/hostnames | Returns a list of hostnames for one time use (the pool will never return already obtained hostnames) | |
|---|---|---|---|
| GET | /resourceaddons/hostnames | Returns a list of hostnames for one time use (the pool will never return already obtained hostnames) |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Returns a list of hostnames
*/
@Api(Description="Returns a list of hostnames")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]::class, StatusCode=200)
open class GetHostNames : IBaseRequest, IHasTenantName, IGet
{
@ApiMember(DataType="string", IsRequired=true, ParameterType="header")
@Validate(Validator="NotEmpty")
override var tenantName:String? = null
/**
* If set, hostnames will be created using it
*/
@ApiMember(DataType="string", Description="If set, hostnames will be created using it", ParameterType="query")
@Validate(Validator="MaximumLength(2)")
open var prefix:String? = null
/**
* Defines how long the hostname will be including the prefix
*/
@ApiMember(DataType="int", Description="Defines how long the hostname will be including the prefix", ParameterType="query")
@Validate(Validator="ExclusiveBetween(7,17)")
open var length:Int? = null
/**
* The number of hostnames to be returned
*/
@ApiMember(DataType="int", Description="The number of hostnames to be returned", IsRequired=true)
@Validate(Validator="GreaterThanOrEqual(1)")
open var count:Int? = null
}
open class ItemsResponse<T>
{
open var items:IList<VariableDto>? = null
open var offset:Int? = null
open var total:Int? = null
open var isGrouped:Boolean? = null
open var responseStatus:ResponseStatus? = null
open var meta:HashMap<String,String>? = null
}
open class VariableDto
{
open var name:String? = null
/**
* Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes
*/
open var value:String? = null
/**
* The data type of the value property
*/
@SerializedName("type") open var Type:ValueDataType? = null
open var description:String? = null
open var isInherited:Boolean? = null
open var environment:Environments? = null
}
enum class ValueDataType
{
String,
Number,
Boolean,
List,
}
enum class Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/resourceaddons/hostnames HTTP/1.1 Host: core.starburst.svc Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":null,"offset":0,"total":0,"isGrouped":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}