reserved instanceIBM Cloud

Get a list of applications for an instance - go

Get a list of applications for an instance.

(mqcloud *MqcloudV1) ListApplications(listApplicationsOptions *ListApplicationsOptions) (result *ApplicationDetailsCollection, response *core.DetailedResponse, err error)
(mqcloud *MqcloudV1) ListApplicationsWithContext(ctx context.Context, listApplicationsOptions *ListApplicationsOptions) (result *ApplicationDetailsCollection, response *core.DetailedResponse, err error)

Request

Instantiate the ListApplicationsOptions struct and set the fields to provide parameter values for the ListApplications 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.
ListQueueManagersOptions The ListQueueManagers 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
offset
int64
 Pagination offset.

Possible values: 0 ≤ value ≤ 99999

Default: 0
limit
int64

The numbers of resources to return.

Possible values: 0 ≤ value ≤ 100

Default: 25

Example: 10

Example request

listApplicationsOptions := &mqcloudv1.ListApplicationsOptions{
  ServiceInstanceGuid: core.StringPtr("a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"),
  Limit: core.Int64Ptr(int64(10)),
}

pager, err := mqcloudService.NewApplicationsPager(listApplicationsOptions)
if err != nil {
  panic(err)
}

var allResults []mqcloudv1.ApplicationDetails
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))

Response

Response Body
UserDetailsCollection

A list of user summaries.
Offset
Always included*
integer
 Pagination offset.
Limit
Always included*
integer

Results per page, same for all collections.

Possible values: value ≤ 50
First
Always included*
 Link to first page of results.
 
  • Href
    string

    The URL of the page the link goes to.
Next
Always included*
 Link to next page of results.
 
  • Href
    string

    The URL of the page the link goes to.
Previous
Always included*
 Link to previous page of results.
 
  • Href
    string

    The URL of the page the link goes to.
Applications
Always included*

List of applications.

Possible values: 0 ≤ number of items ≤ 50
 
  • 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 user details.
Status code  
200 Summary of the returned applications
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

{
  "offset": 25,
  "limit": 25,
  "first": {
    "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/applications?limit=25"
  },
  "next": {
    "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/applications?offset=50&limit=25"
  },
  "previous": {
    "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/applications?offset=25&limit=25"
  },
  "applications": [
    {
      "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"
    }
  ]
}