reserved instanceIBM Cloud

Add an application to an instance - go

Add an application to an instance.

(mqcloud *MqcloudV1) CreateApplication(createApplicationOptions *CreateApplicationOptions) (result *ApplicationCreated, response *core.DetailedResponse, err error)
(mqcloud *MqcloudV1) CreateApplicationWithContext(ctx context.Context, createApplicationOptions *CreateApplicationOptions) (result *ApplicationCreated, response *core.DetailedResponse, err error)

Request

Instantiate the CreateApplicationOptions struct and set the fields to provide parameter values for the CreateApplication 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.
CreateApplicationOptions The CreateApplication 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: a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Name
Required*
string

The name of the application - conforming to MQ rules.

Possible values: 1 ≤ length ≤ 12, Value must match regular expression /^[a-z][-a-z0-9]*$/

Examples: test-app

Example request

createApplicationOptions := mqcloudService.NewCreateApplicationOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "test-app",
)

applicationCreated, response, err := mqcloudService.CreateApplication(createApplicationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationCreated, "", "  ")
fmt.Println(string(b))

Response

ApplicationCreated A response to creating an application, giving the only chance to collect the apikey.
ID
Always included*
string
 The ID of the application which was allocated on creation, and can be used for delete calls.
Name
Always included*
string

The name of the application - conforming to MQ rules.

Possible values: 1 ≤ length ≤ 12
IamServiceID
Always included*
string

The IAM ID of the application

Possible values: 5 ≤ length ≤ 50
CreateApiKeyURI
Always included*
string

The URI to create a new apikey for the application.
Href
Always included*
string

The URL for the application.
ApiKeyName
string
 The name of the api key.
ApiKeyID
string
 The id of the api key.
ApiKey
Always included*
string
 The api key created.
Status code  
201 Created application
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

{
  "id": "0123456789ABCDEF0123456789ABCDEF",
  "name": "test-app",
  "iam_service_id": "IBMid-2700640RCGN",
  "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
  "create_api_key_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641/api_key",
  "api_key_name": "MQ SaaS API",
  "api_key_id": "ApiKey-bafe0ce4-813a-4d81-9f62-3355a3f4e636",
  "api_key": "HsAeqo1WtpC7RtuxQIGpQZUtbf-Xf9ePSO1u9d-cdsc"
}