5.4.6 IM Client list acquisition

Description

Retrieves a list of IM client ID that have been added.

When linking the manager host with your own OSS, or CloudWatch Logs/AzureMonitor provided by JP1/IM - Manager or lower manager, use IM client secret to authentication communication between Intelligent Integrated Management Base and the partner.

Execution permissions

Following permissions are required:

JP1 resource group: *
JP1 permission level: JP1_Console_Admin

API version

Format

Request line

GET /application/component/apiVersion/secret/client/list httpVersion

Request message body

None

Response message body

{
  "clientIds": [IM-client-ID,...]
}

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
`200`	--	API operation was successful.
`403`	`KAJY01000-E`	Insufficient privilege for the user used for authentication.
`500`	`KAJY68009-E`	DB accessible error

Return values

The following information is returned in the response body if the status code is 200:

Member name	Data type	Description
`clientIds`	`string[]`	Array of ID identifying IM client secret

Error message output

API response, including the content of the error message, is returned to the caller when an Execute of Error occurs. The caller displays Message at the caller, using the information of the received response.

Examples

The example below executes the API:

Request:

GET http://immhost01:20703/im/api/v1/secret/client/list

Manager host name: immhost01

Response:

< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "clientIds": [ "clientid1", "clientid2" ]
}

To Page Top