Get cluster nodes configuration request status

Dynatrace Managed Documentation

This page will soon be available only on the dedicated Dynatrace Managed Documentation site. Update your bookmarks.

This API call retrieves the status of cluster node configuration requests.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/v1.0/onpremise/cluster/configuration/status/{requestedAt}

Parameter

Parameter	Type	Description	In	Required
requestedAt	integer	-	path	required

Response

Response codes

Code	Description
200	Success

Example

This request provides information on the given operation status. You can identify a request by its requested timestamp and pass it as a requestedAt path parameter.

Curl

1curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration/status/1" -H  "accept: */*"

Request URL

1https://myManaged.cluster.com/api/v1.0/onpremise/cluster/configuration/status/1

Response body

1{
2    "id": 1619771074449,
3    "request": {
4      "clusterNodes": [
5        {
6          "id": 1,
7          "ipAddress": "10.10.4.2",
8          "webUI": false,
9          "agent": true,
10          "datacenter": "datacenter-1",
11          "kubernetesRole": ""
12        }
13      ]
14    },
15    "state": "SUCCESS",
16    "details": "",
17    "requestedAt": "2021/04/30 08:24:34 Etc/UTC",
18    "finishedAt": "2021/04/30 08:25:50 Etc/UTC",
19    "states": {
20      "DOMAIN_UPDATE": {
21        "id": 0,
22        "request": null,
23        "state": "SUCCESS",
24        "details": "",
25        "requestedAt": "2021/04/30 08:25:13 Etc/UTC",
26        "finishedAt": "2021/04/30 08:25:41 Etc/UTC",
27        "states": {}
28      },
29      "OPERATION_STATE": {
30        "id": 0,
31        "request": null,
32        "state": "SUCCESS",
33        "details": "Update operation state step finished",
34        "requestedAt": "2021/04/30 08:25:41 Etc/UTC",
35        "finishedAt": "2021/04/30 08:25:41 Etc/UTC",
36        "states": {}
37      },
38      "AGENT_TRAFFIC": {
39        "id": 0,
40        "request": null,
41        "state": "SUCCESS",
42        "details": "Update agent traffic step finished",
43        "requestedAt": "2021/04/30 08:25:41 Etc/UTC",
44        "finishedAt": "2021/04/30 08:25:50 Etc/UTC",
45        "states": {}
46      },
47      "WEB_UI": {
48        "id": 0,
49        "request": null,
50        "state": "SUCCESS",
51        "details": "Update web step finished",
52        "requestedAt": "2021/04/30 08:24:36 Etc/UTC",
53        "finishedAt": "2021/04/30 08:25:13 Etc/UTC",
54        "states": {}
55      }
56    }
57  }

Response code

200