View Rolling Upgrade progress status
- Print
- PDF
View Rolling Upgrade progress status
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Description
View the Rolling Upgrade progress status.
Requests
Request URL
POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getRollingUpgradeProgress [KR]
POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getRollingUpgradeProgress [SGN]
POST https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getRollingUpgradeProgress [JPN]
Request headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | - This is the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 (UTC) - If the time difference compared to the API Gateway server is more than 5 minutes, the request is considered invalid x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Value of access key ID issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specify the request body content type as application/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ServiceGroupInstanceNo | String | Y | Target cluster number |
Request examples
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getRollingUpgradeProgress
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: XFS2MSpvTMQZNVTtvymIzMwNeQ
x-ncp-apigw-timestamp: 1709704983976
x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2
{
"serviceGroupInstanceNo": "3427188"
}
curl -X 'POST' 'https://vpcsearchengine.beta-apigw.ntruss.com/api/v2/cluster/getRollingUpgradeProgress'
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H 'x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2'
-H 'x-ncp-apigw-timestamp: 1709704983976'
-H 'x-ncp-apigw-signature-v2: XFS2MSpvTMQZNVTtvymIzMwNeQ/gs3vf1pjgzwOo2g8='
-d '{
"serviceGroupInstanceNo": "3427188"
}'
Responses
Response parameters
public class GetRollingUpgradeProgressResponseVo {
String name;
Integer nodeCount;
GetRollingUpgradeHistoryVersionResponseVo versionVo;
List<NodeServerStatusVo> nodeStatusVoList;
}
public class GetRollingUpgradeHistoryVersionResponseVo {
String currentVersionCode;
String targetVersionCode;
Date actionDate;
}
public class NodeServerStatusVo {
String hostname;
String status;
String nodeRoleCode;
Date updatedDate;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| name | String | Cluster name |
| nodeCount | integer | Number of cluster nodes |
| versionVo | GetRollingUpgradeHistoryVersionResponseVo | Information of upgraded versions |
| currentVersionCode | String | Current version code before upgrade |
| targetVersionCode | String | Version code after upgrade |
| actionDate | Date | Request time of version upgrade |
| nodeStatusVoList | List<NodeServerStatusVo> | Status information per node |
| hostname | String | Host name of node |
| status | String | Progress status |
| nodeRoleCode | String | Role type code per node M:Manager, D:Data |
| updatedDate | Date | Update time of node progress status |
Response examples
{
"code": 0,
"message": "SUCCESS",
"result": {
"name": "sso-test-270",
"nodeCount": 5,
"versionVo": {
"currentVersionCode": "270",
"targetVersionCode": "290",
"actionDate": "2024-03-06 15:01:14"
},
"nodeStatusVoList": [
{
"hostname": "sso-test-270-m-1lv7",
"status": "running",
"nodeRoleCode": "M",
"updatedDate": "2024-03-05 21:14:49"
},
{
"hostname": "sso-test-270-m-1lv8",
"status": "running",
"nodeRoleCode": "M",
"updatedDate": "2024-03-05 21:14:55"
},
{
"hostname": "sso-test-270-d-1lv9",
"status": "complete",
"nodeRoleCode": "D",
"updatedDate": "2024-03-06 15:02:31"
},
{
"hostname": "sso-test-270-d-1lva",
"status": "Upgrade_OpenSearch",
"nodeRoleCode": "D",
"updatedDate": "2024-03-06 15:02:31"
},
{
"hostname": "sso-test-270-d-1lvb",
"status": "running",
"nodeRoleCode": "D",
"updatedDate": "2024-03-05 21:14:44"
}
]
},
"requestId": "b250b9b1-96df-4a04-a755-bf7f4bb1b532"
}
Was this article helpful?