2.25.4 Changing Service Instance Monitoring Status

This API changes the monitoring status of service instances.

Execution permission

Admin, Modify

API version

Request format

POST http[s]://host:port/Analytics/version/services/ServiceInstances/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the execute an operation.
href	string	URL of the execute an operation.
method	string	Name of the method.
type	string	Data format of the object.
parameters	ChangeManagedTypeParamForComp[]	A list of ChangeManagedTypeParamForComp objects necessary to execute an operation. For details about ChangeManagedTypeParamForComp, see the table below.

parameters (Type: ChangeManagedTypeParamForComp)

Attribute	Type	Description
newMonitoringOperationType	enum	Specify the monitoring status to be changed to. (For details about the specifiable values, see the table MonitoringOperationType in List of enumerators.) The specifiable values are as follows: Monitor Ignore
ids	long[]	Specify the ID for identifying the component. To specify multiple virtual machines, specify the IDs concurrently.

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

(For details about the specifiable values, see the table MonitoringOperationType in List of enumerators.)

The specifiable values are as follows:

Monitor
Ignore

ids

long[]

Specify the ID for identifying the component. To specify multiple virtual machines, specify the IDs concurrently.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute	Type	Description
instanceID	string	Indicates the ID of the Instance.
created	string	Indicates the date the object is generated in ISO 8601 format.
updated	string	Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.
completed	string	Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.
state	string	One of the following values is set: "failed": The operation did not terminate normally. "success": The operation terminated normally.
affectedResource	string[]	Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.
result	anyType[]	A list of objects. No value is set.

Status codes

Status code	Reason phrase	Description
200	OK	Success.
400	Bad Request	A format of request body is invalid.
401	Unauthorized	No login privilege.
403	Forbidden	No update privilege.
404	Not Found	The resource was not found.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke HTTP/1.1
Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36
Host: localhost:8080
Accept: application/json
Accept-Language: ja

[Request Body]
{
  "name": "changeManagedType",
  "href": "http://10.210.177.133:22015/Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters": [
    {
      "newMonitoringOperationType": "Monitor",
      "ids": [
        1000001
      ]
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 21 Oct 2020 00:35:33 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language
Cache-Control: no-cache
Access-Control-Allow-Origin: http://localhost:8080
WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=97
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "58d4757a-2e9e-44cd-9aaf-2cbc54a5de9c",
  "created" : "2020-10-21T09:35:33.956+09:00",
  "updated" : "2020-10-21T09:35:34.128+09:00",
  "completed" : "2020-10-21T09:35:34.128+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}