{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Service Package API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Service Package", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Gets The List Of Service Packages Deployed On A Service Fabric Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Returns the information about the service packages deployed on a Service Fabric node for the given application." }, { "info": { "name": "Microsoft Azure Gets The List Of Service Packages Deployed On A Service Fabric Node Matching Exactly The Specified Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "servicePackageName", "value": "", "type": "path", "description": "The name of the service package." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter." }, { "info": { "name": "Microsoft Azure Gets The Information About Health Of A Service Package For A Specific Application Deployed For A Service Fabric Node And Application", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName/$/GetHealth", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "servicePackageName", "value": "", "type": "path", "description": "The name of the service package." }, { "name": "EventsHealthStateFilter", "value": "", "type": "query", "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state." }, { "info": { "name": "Microsoft Azure Gets The Information About Health Of Service Package For A Specific Application Deployed On A Service Fabric Node Using The Specified Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName/$/GetHealth", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "servicePackageName", "value": "", "type": "path", "description": "The name of the service package." }, { "name": "EventsHealthStateFilter", "value": "", "type": "query", "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fi" }, { "info": { "name": "Microsoft Azure Sends A Health Report On The Service Fabric Deployed Service Package", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServicePackages/:servicePackageName/$/ReportHealth", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "servicePackageName", "value": "", "type": "path", "description": "The name of the service package." }, { "name": "Immediate", "value": "", "type": "query", "description": "A flag that indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.
The report is sent to a Service Fabric gateway Service, which forwards to the health store.
The report may be accepted by the gateway, but rejected by the health store after extra validation.
For example, the health store may reject the report because of an invalid parameter, " }, { "info": { "name": "Microsoft Azure Downloads All Of The Code Packages Associated With Specified Service Manifest On The Specified Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/DeployServicePackage", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade." } ] } ], "bundled": true }