reserved instanceIBM Cloud

Return configuration options - go

Return configuration options (for example, available deployment locations, queue manager sizes).

(mqcloud *MqcloudV1) GetOptions(getOptionsOptions *GetOptionsOptions) (result *ConfigurationOptions, response *core.DetailedResponse, err error)

(mqcloud *MqcloudV1) GetOptionsWithContext(ctx context.Context, getOptionsOptions *GetOptionsOptions) (result *ConfigurationOptions, response *core.DetailedResponse, err error)

Request

Instantiate the GetOptionsOptions struct and set the fields to provide parameter values for the GetOptions method.

Parameter WithContext method only
ctx
Context
 A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
GetUsageDetailsOptions The GetUsageDetails options
ServiceInstanceGuid
Required*
string

The GUID that uniquely identifies the IBM® MQ as a Service instance.

Possible values: length = 36, Value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

Example request

getOptionsOptions := mqcloudService.NewGetOptionsOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
)

configurationOptions, response, err := mqcloudService.GetOptions(getOptionsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(configurationOptions, "", "  ")
fmt.Println(string(b))

Response

Response Body
ConfigurationOptions
 ConfigurationOptions (for example, available deployment locations, queue manager sizes)
locations
[]string

List of deployment locations.

Possible values: 1 ≤ number of items ≤ 20, 2 ≤ length ≤ 150, Value must match regular expression /^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$/
sizes
[]string

List of queue manager sizes.

Possible values: [xsmall,small,medium,large]

Possible values: 1 ≤ number of items ≤ 20
versions
[]string

List of queue manager versions.

Possible values: 1 ≤ number of items ≤ 12
latest_version
string

The latest Queue manager version.

Possible values: 7 ≤ length ≤ 15, Value must match regular expression /^[0-9]+.[0-9]+.[0-9]+_[0-9]+$/

Example: 9.3.2_2
Status code  
200 Configuration options
301 URI has permanently Moved
400 Bad Request
401 Unauthorized
404 Resource not found
429 Service Is Overused
500 Internal Server Error

Example response

Success example

{
  "locations": [
    "ibmcloud_eu_de"
  ],
  "sizes": [
    "xsmall",
    "small",
    "medium",
    "large"
  ],
  "versions": [
    "9.3.3_1"
  ],
  "latest_version": "9.3.3_1"
}