{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Pod Replica Links API", "version": "2.52" }, "items": [ { "info": { "name": "Pod Replica Links", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Pod Replica Links", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pod-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the list of pod replica links that are configured between arrays." }, { "info": { "name": "Pure Storage Create Pod Replica Links", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/pod-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" } ] }, "docs": "Creates pod replica links between two arrays. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger " }, { "info": { "name": "Pure Storage Modify Pod Replica Links", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/pod-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies pod replica links. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` s" }, { "info": { "name": "Pure Storage Delete Pod Replica Links", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/pod-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" } ] }, "docs": "Deletes pod replica links. The `local_pod_names` and `remote_pod_names` are required. Valid values are `replicating`, `baselining`, `paused`, `unhealthy`, `quiescing`, and `quiesced`. A status of `replicating` indicates that the source array is replicating to the target array. A status of `baselining` indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the `baselining` st" }, { "info": { "name": "Pure Storage List Pod Replica Link Lag", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pod-replica-links/lag", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "end_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The number of milliseconds between samples of historical data.\nFor array-wide performance metrics (`/arrays/performance` endpoint),\nvalid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes),\n`1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor performance metrics on storage objects (`/performance` endpoint),\nsuch as volumes,\nvalid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes),\n`7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor space metrics, (`/space` endpoint),\nvalid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours),\n`28800000` (8 hours), and `86400000` (24 hours).\nInclude the `start_time` parameter to display the performance data\nstarting at the specified start time.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nInclude the `end_time` parameter to display the performance data until the specified end time.\nIf `end_time`is not specified, the end time will default to the current time.\nIf the `resolution` parameter is not specified\nbut either the `start_time` or `end_time` parameter is,\nthen `resolution` will default to the lowest valid resolution.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "start_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point." }, { "info": { "name": "Pure Storage List Replica Link Performance Data", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pod-replica-links/performance/replication", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "end_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The number of milliseconds between samples of historical data.\nFor array-wide performance metrics (`/arrays/performance` endpoint),\nvalid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes),\n`1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor performance metrics on storage objects (`/performance` endpoint),\nsuch as volumes,\nvalid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes),\n`7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor space metrics, (`/space` endpoint),\nvalid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours),\n`28800000` (8 hours), and `86400000` (24 hours).\nInclude the `start_time` parameter to display the performance data\nstarting at the specified start time.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nInclude the `end_time` parameter to display the performance data until the specified end time.\nIf `end_time`is not specified, the end time will default to the current time.\nIf the `resolution` parameter is not specified\nbut either the `start_time` or `end_time` parameter is,\nthen `resolution` will default to the lowest valid resolution.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "start_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" }, { "name": "total_only", "value": "", "type": "query", "description": "If set to `true`, only return the aggregate value of all items after filtering.\nFor real-time performance, the values are aggregated for the latest timestamp.\nFor historical performance, the values are aggregated for each timestamp from\n`start_time` to `end_time`. Where it makes more sense, the average value is\ndisplayed instead. The values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "The monitoring interface or metric that provides the total\nnumber of `bytes` of `replication` data transmitted and\nreceived `per second`.\n" }, { "info": { "name": "Pure Storage List Replica Link Performance Data with Array Details", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pod-replica-links/performance/replication/by-array", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "end_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The number of milliseconds between samples of historical data.\nFor array-wide performance metrics (`/arrays/performance` endpoint),\nvalid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes),\n`1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor performance metrics on storage objects (`/performance` endpoint),\nsuch as volumes,\nvalid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes),\n`7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor space metrics, (`/space` endpoint),\nvalid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours),\n`28800000` (8 hours), and `86400000` (24 hours).\nInclude the `start_time` parameter to display the performance data\nstarting at the specified start time.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nInclude the `end_time` parameter to display the performance data until the specified end time.\nIf `end_time`is not specified, the end time will default to the current time.\nIf the `resolution` parameter is not specified\nbut either the `start_time` or `end_time` parameter is,\nthen `resolution` will default to the lowest valid resolution.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "start_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" }, { "name": "total_only", "value": "", "type": "query", "description": "If set to `true`, only return the aggregate value of all items after filtering.\nFor real-time performance, the values are aggregated for the latest timestamp.\nFor historical performance, the values are aggregated for each timestamp from\n`start_time` to `end_time`. Where it makes more sense, the average value is\ndisplayed instead. The values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "The monitoring interface that provides the total number of `bytes`\nof `replication` data transmitted and received `per second`.\nThis data is organized by `array` and further categorized by\nthe specific `replica link`, `source array`, and `target array`\nto provide granular visibility into network throughput.\n" }, { "info": { "name": "Pure Storage List Policy Mappings", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pod-replica-links/mappings/policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "pod_replica_link_ids", "value": "", "type": "query", "description": "A comma-separated list of pod replica link IDs.\nIf, after filtering, there is not at least one resource that matches each of the elements,\nthen an error is returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays a list of policy mappings.\n" }, { "info": { "name": "Pure Storage Modify Policy Mappings", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/pod-replica-links/mappings/policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "local_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_names` query parameter.\n" }, { "name": "local_pod_names", "value": "", "type": "query", "description": "A comma-separated list of local pod names. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `local_pod_ids` query parameter.\n" }, { "name": "pod_replica_link_ids", "value": "", "type": "query", "description": "A comma-separated list of pod replica link IDs.\nIf, after filtering, there is not at least one resource that matches each of the elements,\nthen an error is returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm IDs.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_ids and remote_names parameters cannot be set together.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "The comma-separated list of remote array or realm names.\nIf, after filtering, there is not at least one resource\nthat matches each of the elements, an error is returned.\nThe remote_names and remote_ids parameters cannot be set together.\n" }, { "name": "remote_pod_ids", "value": "", "type": "query", "description": "A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource\nthat matches each of the elements, then an error is returned. This cannot be provided together\nwith the `remote_pod_names` query parameter.\n" }, { "name": "remote_pod_names", "value": "", "type": "query", "description": "A comma-separated list of remote pod names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_pod_ids` query parameter.\n" }, { "name": "remote_policy_ids", "value": "", "type": "query", "description": "A comma-separated list of remote policy IDs. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be\nprovided together with the `remote_policy_names` query parameter.\n" }, { "name": "remote_policy_names", "value": "", "type": "query", "description": "A comma-separated list of remote policy names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be\nprovided together with the `remote_policy_ids` query parameter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies policy mappings of a replica link.\nValid `mapping` values are `connected` and `disconnected`. `connected` indicates that the\nsource policy and its attachments will be mirrored on the target pod.\n`disconnected` indicates that the associated policy and its attachments are independent\nfrom any policy on the remote. This operation can only be performed on\nthe target side of a pod replica link.\n" }, { "info": { "name": "Pure Storage Get Pod Replica Links", "type": "http" }, "http": { "method": "GET", "url": "/api/1.5/pod-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A list of member IDs. Member IDs separated by a `+` indicate that both\nmembers must be present in each element. Member IDs separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A list of member names. Member names separated by a `+` indicate that both\nmembers must be present in each element. Member names separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A list of source IDs. Source IDs separated by a `+` indicate that both\nsources must be present in each element. Source IDs separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A list of source names. Source names separated by a `+` indicate that both\nsources must be present in each element. Source names separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_ids", "value": "", "type": "query", "description": "A list of target IDs. Target IDs separated by a `+` indicate that both\ntargets must be present in each element. Target IDs separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_names", "value": "", "type": "query", "description": "A list of target names. Target names separated by a `+` indicate that both\ntargets must be present in each element. Target names separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target names separated by a `+`\nmust be entered in the same item cell.\n" } ] }, "docs": "Retrieves information about pod replica links.\n" } ] } ], "bundled": true }