Skip to content

Commit d1f8e89

Browse files
EliShteinmanEliShteinman
committed
Merge upstream PR redis#3338 (rc_api_sync) into feature/docker-support
Update Redis Cloud OpenAPI spec. Upstream merge commit: 78894f0 Content commit: b9f2eb4
2 parents ec38624 + 78894f0 commit d1f8e89

1 file changed

Lines changed: 303 additions & 0 deletions

File tree

‎content/operate/rc/api/api-reference/openapi.json‎

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7236,6 +7236,75 @@
72367236
}
72377237
}
72387238
},
7239+
"/subscriptions/{subscriptionId}/databases/{databaseId}/traffic/resume": {
7240+
"post": {
7241+
"tags": [
7242+
"Databases - Pro"
7243+
],
7244+
"summary": "Resume Pro database traffic",
7245+
"description": "Resumes traffic for the specified Pro database.",
7246+
"operationId": "resumeBdbTraffic",
7247+
"parameters": [
7248+
{
7249+
"name": "subscriptionId",
7250+
"in": "path",
7251+
"description": "Subscription ID.",
7252+
"required": true,
7253+
"schema": {
7254+
"minimum": 0,
7255+
"type": "integer",
7256+
"format": "int32"
7257+
}
7258+
},
7259+
{
7260+
"name": "databaseId",
7261+
"in": "path",
7262+
"description": "Database ID.",
7263+
"required": true,
7264+
"schema": {
7265+
"minimum": 0,
7266+
"type": "integer",
7267+
"format": "int32"
7268+
}
7269+
}
7270+
],
7271+
"responses": {
7272+
"400": {
7273+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
7274+
},
7275+
"412": {
7276+
"description": "Precondition Failed - Feature flag for this flow is off"
7277+
},
7278+
"204": {
7279+
"description": "Traffic resumed"
7280+
},
7281+
"401": {
7282+
"description": "Unauthorized - Authentication failed for requested resource"
7283+
},
7284+
"403": {
7285+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
7286+
},
7287+
"404": {
7288+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
7289+
},
7290+
"408": {
7291+
"description": "Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period"
7292+
},
7293+
"409": {
7294+
"description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name)"
7295+
},
7296+
"429": {
7297+
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
7298+
},
7299+
"500": {
7300+
"description": "Internal system error - If this error persists, please contact customer support"
7301+
},
7302+
"503": {
7303+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
7304+
}
7305+
}
7306+
}
7307+
},
72397308
"/subscriptions/{subscriptionId}/databases/{databaseId}/import": {
72407309
"get": {
72417310
"tags": [
@@ -7972,6 +8041,75 @@
79728041
}
79738042
}
79748043
},
8044+
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/traffic/resume": {
8045+
"post": {
8046+
"tags": [
8047+
"Databases - Essentials"
8048+
],
8049+
"summary": "Resume Essentials database traffic",
8050+
"description": "Resumes traffic for the specified Essentials database.",
8051+
"operationId": "resumeBdbTraffic_1",
8052+
"parameters": [
8053+
{
8054+
"name": "subscriptionId",
8055+
"in": "path",
8056+
"description": "Subscription ID.",
8057+
"required": true,
8058+
"schema": {
8059+
"minimum": 0,
8060+
"type": "integer",
8061+
"format": "int32"
8062+
}
8063+
},
8064+
{
8065+
"name": "databaseId",
8066+
"in": "path",
8067+
"description": "Database ID.",
8068+
"required": true,
8069+
"schema": {
8070+
"minimum": 0,
8071+
"type": "integer",
8072+
"format": "int32"
8073+
}
8074+
}
8075+
],
8076+
"responses": {
8077+
"400": {
8078+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
8079+
},
8080+
"412": {
8081+
"description": "Precondition Failed - Feature flag for this flow is off"
8082+
},
8083+
"204": {
8084+
"description": "Traffic resumed"
8085+
},
8086+
"401": {
8087+
"description": "Unauthorized - Authentication failed for requested resource"
8088+
},
8089+
"403": {
8090+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
8091+
},
8092+
"404": {
8093+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
8094+
},
8095+
"408": {
8096+
"description": "Request Timeout - The server didn't receive a complete request message within the server's allotted timeout period"
8097+
},
8098+
"409": {
8099+
"description": "Conflict - request could not be processed because of a conflict (primarily due to another resource that exist with new updated name)"
8100+
},
8101+
"429": {
8102+
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
8103+
},
8104+
"500": {
8105+
"description": "Internal system error - If this error persists, please contact customer support"
8106+
},
8107+
"503": {
8108+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
8109+
}
8110+
}
8111+
}
8112+
},
79758113
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/import": {
79768114
"get": {
79778115
"tags": [
@@ -9691,6 +9829,76 @@
96919829
}
96929830
}
96939831
},
9832+
"/subscriptions/{subscriptionId}/databases/{databaseId}/traffic": {
9833+
"get": {
9834+
"tags": [
9835+
"Databases - Pro"
9836+
],
9837+
"summary": "Get Pro database traffic",
9838+
"description": "Gets traffic information for the specified Pro database. If the database was not a source in a redirect endpoints operation, a not found error will be returned.",
9839+
"operationId": "getDatabaseTraffic",
9840+
"parameters": [
9841+
{
9842+
"name": "subscriptionId",
9843+
"in": "path",
9844+
"description": "Subscription ID.",
9845+
"required": true,
9846+
"schema": {
9847+
"minimum": 0,
9848+
"type": "integer",
9849+
"format": "int32"
9850+
}
9851+
},
9852+
{
9853+
"name": "databaseId",
9854+
"in": "path",
9855+
"description": "Database ID.",
9856+
"required": true,
9857+
"schema": {
9858+
"minimum": 0,
9859+
"type": "integer",
9860+
"format": "int32"
9861+
}
9862+
}
9863+
],
9864+
"responses": {
9865+
"400": {
9866+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
9867+
},
9868+
"412": {
9869+
"description": "Precondition Failed - Feature flag for this flow is off"
9870+
},
9871+
"200": {
9872+
"description": "OK",
9873+
"content": {
9874+
"application/json": {
9875+
"schema": {
9876+
"$ref": "#/components/schemas/DatabaseTrafficStateResponse"
9877+
}
9878+
}
9879+
}
9880+
},
9881+
"401": {
9882+
"description": "Unauthorized - Authentication failed for requested resource"
9883+
},
9884+
"403": {
9885+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
9886+
},
9887+
"404": {
9888+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
9889+
},
9890+
"429": {
9891+
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
9892+
},
9893+
"500": {
9894+
"description": "Internal system error - If this error persists, please contact customer support"
9895+
},
9896+
"503": {
9897+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
9898+
}
9899+
}
9900+
}
9901+
},
96949902
"/subscriptions/{subscriptionId}/databases/{databaseId}/slow-log": {
96959903
"get": {
96969904
"tags": [
@@ -10312,6 +10520,76 @@
1031210520
}
1031310521
}
1031410522
},
10523+
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/traffic": {
10524+
"get": {
10525+
"tags": [
10526+
"Databases - Essentials"
10527+
],
10528+
"summary": "Get Essentials database traffic",
10529+
"description": "Gets traffic information for the specified Essentials database. If the database was not a source in a redirect endpoints operation, a not found error will be returned.",
10530+
"operationId": "getDatabaseTraffic_1",
10531+
"parameters": [
10532+
{
10533+
"name": "subscriptionId",
10534+
"in": "path",
10535+
"description": "Subscription ID.",
10536+
"required": true,
10537+
"schema": {
10538+
"minimum": 0,
10539+
"type": "integer",
10540+
"format": "int32"
10541+
}
10542+
},
10543+
{
10544+
"name": "databaseId",
10545+
"in": "path",
10546+
"description": "Database ID.",
10547+
"required": true,
10548+
"schema": {
10549+
"minimum": 0,
10550+
"type": "integer",
10551+
"format": "int32"
10552+
}
10553+
}
10554+
],
10555+
"responses": {
10556+
"400": {
10557+
"description": "Bad Request - The server cannot process the request due to something that is perceived to be a client error"
10558+
},
10559+
"412": {
10560+
"description": "Precondition Failed - Feature flag for this flow is off"
10561+
},
10562+
"200": {
10563+
"description": "OK",
10564+
"content": {
10565+
"application/json": {
10566+
"schema": {
10567+
"$ref": "#/components/schemas/DatabaseTrafficStateResponse"
10568+
}
10569+
}
10570+
}
10571+
},
10572+
"401": {
10573+
"description": "Unauthorized - Authentication failed for requested resource"
10574+
},
10575+
"403": {
10576+
"description": "Forbidden - Not allowed to access requested resource (primarily due to client source IP API Key restrictions)"
10577+
},
10578+
"404": {
10579+
"description": "Not Found - The resource you were trying to reach was not found or does not exist"
10580+
},
10581+
"429": {
10582+
"description": "Too Many Requests - Too many resources are concurrently created / updated / deleted in the account. Please re-submit API requests after resource changes are completed)"
10583+
},
10584+
"500": {
10585+
"description": "Internal system error - If this error persists, please contact customer support"
10586+
},
10587+
"503": {
10588+
"description": "Service Unavailable - Server is temporarily unable to handle the request, please try again later. If this error persists, please contact customer support "
10589+
}
10590+
}
10591+
}
10592+
},
1031510593
"/fixed/subscriptions/{subscriptionId}/databases/{databaseId}/slow-log": {
1031610594
"get": {
1031710595
"tags": [
@@ -12740,6 +13018,31 @@
1274013018
},
1274113019
"description": "Active-Active VPC peering update request message"
1274213020
},
13021+
"DatabaseTrafficStateResponse": {
13022+
"type": "object",
13023+
"properties": {
13024+
"bdbId": {
13025+
"type": "integer",
13026+
"format": "int32"
13027+
},
13028+
"trafficStatus": {
13029+
"type": "string"
13030+
},
13031+
"canResume": {
13032+
"type": "boolean"
13033+
},
13034+
"resumeInProgress": {
13035+
"type": "boolean"
13036+
},
13037+
"stopReason": {
13038+
"type": "string"
13039+
},
13040+
"resumeEligibleAt": {
13041+
"type": "string",
13042+
"format": "date-time"
13043+
}
13044+
}
13045+
},
1274313046
"DataPersistenceEntry": {
1274413047
"type": "object",
1274513048
"properties": {

0 commit comments

Comments
 (0)