{ "opencollection": "1.0.0", "info": { "name": "Network Monitoring Vn Monitoring API", "version": "20160918" }, "items": [ { "info": { "name": "vnMonitoring", "type": "folder" }, "items": [ { "info": { "name": "A path analysis query.", "type": "http" }, "http": { "method": "POST", "url": "/20160918/pathAnalysis", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "cache-control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this method to initiate a [Network Path Analyzer](/iaas/Content/Network/Concepts/path_analyzer.htm) analysis. This method returns\nan opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds.\n\nIf the work request status is successful, use [ListWorkRequestResults](#/en/VnConfigAdvisor/latest/WorkRequestResult/ListWorkRequestResults)\nwith the work request ID to ask for the successful analysis results. If the work request status is failed, use\n[ListW" }, { "info": { "name": "Gets a list of all PathAnalyzerTests in a compartment", "type": "http" }, "http": { "method": "GET", "url": "/20160918/pathAnalyzerTests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns only resources whose `lifecycleState` matches the given `lifecycleState`." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter that returns only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" } ] }, "docs": "Returns a list of all `PathAnalyzerTests` in a compartment.\n" }, { "info": { "name": "Creates a new PathAnalyzerTest", "type": "http" }, "http": { "method": "POST", "url": "/20160918/pathAnalyzerTests", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new `PathAnalyzerTest` resource." }, { "info": { "name": "Gets PathAnalyzerTest", "type": "http" }, "http": { "method": "GET", "url": "/20160918/pathAnalyzerTests/:pathAnalyzerTestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pathAnalyzerTestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource." } ] }, "docs": "Gets a `PathAnalyzerTest` using its identifier." }, { "info": { "name": "Updates PathAnalyzerTest", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/pathAnalyzerTests/:pathAnalyzerTestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pathAnalyzerTestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a `PathAnalyzerTest` using its identifier." }, { "info": { "name": "Deletes PathAnalyzerTest", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/pathAnalyzerTests/:pathAnalyzerTestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pathAnalyzerTestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource." } ] }, "docs": "Deletes a `PathAnalyzerTest` resource using its identifier." }, { "info": { "name": "Moves PathAnalyzerTest resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20160918/pathAnalyzerTests/:pathAnalyzerTestId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pathAnalyzerTestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a `PathAnalyzerTest` resource from one compartment to another based on the identifier.\n" }, { "info": { "name": "Lists work requests in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order for `timeAccepted` is descending.\n" }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources whose `lifecycleState` matches the given `OperationStatus`." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." } ] }, "docs": "Lists the work requests in a compartment." }, { "info": { "name": "Gets the details of a work request.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request." } ] }, "docs": "Gets the details of a work request." }, { "info": { "name": "Lists work request errors.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order for `timeCreated` is descending.\n" } ] }, "docs": "Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.\n" }, { "info": { "name": "Lists work request logs.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order for `timeCreated` is descending.\n" } ] }, "docs": "Returns a (paginated) list of logs for the work request with the given ID.\n" }, { "info": { "name": "Lists work request results.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/workRequests/:workRequestId/results", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "resultType", "value": "", "type": "query", "description": "The type of results to return." } ] }, "docs": "Returns a (paginated) list of results for a successful work request. This information is used to\nbuild the final report output.\n" } ] } ], "bundled": true }