| 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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
# @Api(Description="Returns a list of hostnames")
# @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]), StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetHostNames(IBaseRequest, IHasTenantName, IGet):
"""
Returns a list of hostnames
"""
# @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
# @Validate(Validator="NotEmpty")
tenant_name: Optional[str] = None
# @ApiMember(DataType="string", Description="If set, hostnames will be created using it", ParameterType="query")
# @Validate(Validator="MaximumLength(2)")
prefix: Optional[str] = None
"""
If set, hostnames will be created using it
"""
# @ApiMember(DataType="int", Description="Defines how long the hostname will be including the prefix", ParameterType="query")
# @Validate(Validator="ExclusiveBetween(7,17)")
length: Optional[int] = None
"""
Defines how long the hostname will be including the prefix
"""
# @ApiMember(DataType="int", Description="The number of hostnames to be returned", IsRequired=true)
# @Validate(Validator="GreaterThanOrEqual(1)")
count: int = 0
"""
The number of hostnames to be returned
"""
class ValueDataType(str, Enum):
STRING = 'String'
NUMBER = 'Number'
BOOLEAN = 'Boolean'
LIST = 'List'
class Environments(str, Enum):
LAB = 'Lab'
POC = 'Poc'
DEV = 'Dev'
TEST = 'Test'
INT_ = 'Int'
UAT = 'Uat'
PROD = 'Prod'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VariableDto:
name: Optional[str] = None
value: Optional[str] = None
"""
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
"""
type: Optional[ValueDataType] = None
"""
The data type of the value property
"""
description: Optional[str] = None
is_inherited: bool = False
environment: Optional[Environments] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemsResponse(Generic[T]):
items: Optional[IList[VariableDto]] = None
offset: int = 0
total: int = 0
is_grouped: bool = False
response_status: Optional[ResponseStatus] = None
meta: Optional[Dict[str, str]] = None
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"}}