reserved instanceIBM Cloud

Get an application for an instance - go

Get an application for an instance.

(mqcloud *MqcloudV1) GetApplication(getApplicationOptions *GetApplicationOptions) (result *ApplicationDetails, response *core.DetailedResponse, err error)
(mqcloud *MqcloudV1) GetApplicationWithContext(ctx context.Context, getApplicationOptions *GetApplicationOptions) (result *ApplicationDetails, response *core.DetailedResponse, err error)

Request

Instantiate the GetApplicationOptions struct and set the fields to provide parameter values for the GetApplication 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.
GetApplicationOptions The GetApplication 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
ApplicationID
Required*
string

The id of the application.

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

Example: 0123456789ABCDEF0123456789ABCDEF

Example request

getApplicationOptions := mqcloudService.NewGetApplicationOptions(
  "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
  "0123456789ABCDEF0123456789ABCDEF",
)

applicationDetails, response, err := mqcloudService.GetApplication(getApplicationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationDetails, "", "  ")
fmt.Println(string(b))

Response

Response Body
ApplicationDetails

A summary of the application for use in a list of applications
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.
Status code  
200 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"
}