HTTP API-verwijzingHTTP API reference

De uitbrei ding Durable Functions maakt een reeks ingebouwde HTTP-Api's die kunnen worden gebruikt voor het uitvoeren van beheer taken voor Orchestrations, entiteitenen taak hubs.The Durable Functions extension exposes a set of built-in HTTP APIs that can be used to perform management tasks on orchestrations, entities, and task hubs. Deze HTTP-Api's zijn uitbreid bare webhooks die worden geautoriseerd door de Azure Functions-host, maar rechtstreeks worden verwerkt door de uitbrei ding Durable Functions.These HTTP APIs are extensibility webhooks that are authorized by the Azure Functions host but handled directly by the Durable Functions extension.

Voor alle HTTP-Api's die door de extensie worden geïmplementeerd, zijn de volgende para meters vereist.All HTTP APIs implemented by the extension require the following parameters. Het gegevens type van alle para meters is string.The data type of all parameters is string.

ParameterParameter ParametertypeParameter Type DescriptionDescription
taskHub QuerytekenreeksQuery string De naam van de taak hub.The name of the task hub. Indien niet opgegeven, wordt ervan uitgegaan dat de naam van de taak-hub van de huidige functie-app wordt gebruikt.If not specified, the current function app's task hub name is assumed.
connection QuerytekenreeksQuery string De naam van de Connection String voor het opslag account.The name of the connection string for the storage account. Als deze niet wordt opgegeven, wordt aangenomen dat de standaard connection string voor de functie-app wordt gebruikt.If not specified, the default connection string for the function app is assumed.
systemKey QuerytekenreeksQuery string De autorisatie sleutel die is vereist om de API aan te roepen.The authorization key required to invoke the API.

systemKeyis een autorisatie sleutel die automatisch wordt gegenereerd door de Azure Functions-host.systemKey is an authorization key autogenerated by the Azure Functions host. Het geeft specifiek toegang tot de duurzame Api's voor taak uitbreidingen en kan op dezelfde manier worden beheerd als andere autorisatie sleutels.It specifically grants access to the Durable Task extension APIs and can be managed the same way as other authorization keys. U kunt url's genereren die de taskHubjuiste connectionwaarden bevatten, en systemKey query teken reeks gebruiken met behulp van Orchestrator client binding api's, CreateCheckStatusResponse zoals CreateHttpManagementPayload de api's en in .net, createCheckStatusResponse of de en createHttpManagementPayload Api's in Java script.You can generate URLs that contain the correct taskHub, connection, and systemKey query string values using orchestration client binding APIs, such as the CreateCheckStatusResponse and CreateHttpManagementPayload APIs in .NET, or the createCheckStatusResponse and createHttpManagementPayload APIs in JavaScript.

In de volgende secties worden de specifieke HTTP-Api's beschreven die worden ondersteund door de uitbrei ding en worden voor beelden gegeven van hoe ze kunnen worden gebruikt.The next few sections cover the specific HTTP APIs supported by the extension and provide examples of how they can be used.

Indeling startenStart orchestration

Het uitvoeren van een nieuw exemplaar van de opgegeven Orchestrator-functie wordt gestart.Starts executing a new instance of the specified orchestrator function.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

POST /admin/extensions/DurableTaskExtension/orchestrators/{functionName}/{instanceId?}
     ?taskHub={taskHub}
     &connection={connectionName}
     &code={systemKey}

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

POST /runtime/webhooks/durabletask/orchestrators/{functionName}/{instanceId?}
     ?taskHub={taskHub}
     &connection={connectionName}
     &code={systemKey}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meters:Request parameters for this API include the default set mentioned previously as well as the following unique parameters:

VeldField ParametertypeParameter type DescriptionDescription
functionName URLURL De naam van de Orchestrator-functie die moet worden gestart.The name of the orchestrator function to start.
instanceId URLURL Optionele para meter.Optional parameter. De ID van het Orchestration-exemplaar.The ID of the orchestration instance. Als deze niet wordt opgegeven, begint de Orchestrator-functie met een wille keurige exemplaar-ID.If not specified, the orchestrator function will start with a random instance ID.
{content} Inhoud van aanvraagRequest content Optioneel.Optional. De functie-invoer voor de JSON-indeling van Orchestrator.The JSON-formatted orchestrator function input.

AntwoordResponse

Er kunnen verschillende mogelijke status code waarden worden geretourneerd.Several possible status code values can be returned.

  • HTTP 202 (geaccepteerd) : De opgegeven Orchestrator-functie is gepland om te worden uitgevoerd.HTTP 202 (Accepted): The specified orchestrator function was scheduled to start running. De Location antwoord header bevat een URL voor het navragen van de Orchestration-status.The Location response header contains a URL for polling the orchestration status.
  • HTTP 400 (ongeldige aanvraag) : De opgegeven Orchestrator-functie bestaat niet, de opgegeven exemplaar-ID is ongeldig of de aanvraag inhoud is geen geldige JSON.HTTP 400 (Bad request): The specified orchestrator function doesn't exist, the specified instance ID was not valid, or request content was not valid JSON.

Hier volgt een voorbeeld aanvraag waarmee een RestartVMs Orchestrator-functie wordt gestart en die JSON-object Payload bevat:The following is an example request that starts a RestartVMs orchestrator function and includes JSON object payload:

POST /runtime/webhooks/durabletask/orchestrators/RestartVMs?code=XXX
Content-Type: application/json
Content-Length: 83

{
    "resourceGroup": "myRG",
    "subscriptionId": "111deb5d-09df-4604-992e-a968345530a9"
}

De nettolading van de reactie voor de HTTP 202- cases is een JSON-object met de volgende velden:The response payload for the HTTP 202 cases is a JSON object with the following fields:

VeldField DescriptionDescription
id De ID van het Orchestration-exemplaar.The ID of the orchestration instance.
statusQueryGetUri De status-URL van het Orchestrator-exemplaar.The status URL of the orchestration instance.
sendEventPostUri De URL van de functie ' raise ' van het Orchestrator-exemplaar.The "raise event" URL of the orchestration instance.
terminatePostUri De ' Terminate ' URL van het Orchestrator-exemplaar.The "terminate" URL of the orchestration instance.
purgeHistoryDeleteUri De URL voor het verwijderen van de geschiedenis van het Orchestrator-exemplaar.The "purge history" URL of the orchestration instance.
rewindPostUri evaluatie De ' rewinde ' URL van het Orchestrator-exemplaar.(preview) The "rewind" URL of the orchestration instance.

Het gegevens type van alle velden is string.The data type of all fields is string.

Hier volgt een voor beeld van een nettolading voor een Orchestrator- abc123 exemplaar met als id (opgemaakt voor de Lees baarheid):Here is an example response payload for an orchestration instance with abc123 as its ID (formatted for readability):

{
    "id": "abc123",
    "purgeHistoryDeleteUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123?code=XXX",
    "sendEventPostUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123/raiseEvent/{eventName}?code=XXX",
    "statusQueryGetUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123?code=XXX",
    "terminatePostUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123/terminate?reason={text}&code=XXX"
}

Het HTTP-antwoord is bedoeld om compatibel te zijn met het polling Consumer-patroon.The http response is intended to be compatible with the Polling Consumer Pattern. Het bevat ook de volgende belang rijke reactie headers:It also includes the following notable response headers:

  • Locatie: De URL van het status eindpunt.Location: The URL of the status endpoint. Deze URL bevat dezelfde waarde als het statusQueryGetUri veld.This URL contains the same value as the statusQueryGetUri field.
  • Opnieuw proberen na: Het aantal seconden dat moet worden gewacht tussen polling bewerkingen.Retry-After: The number of seconds to wait between polling operations. De standaardwaarde is 10.The default value is 10.

Zie de documentatie over http async-tracering voor meer informatie over het asynchrone HTTP polling-patroon.For more information on the asynchronous HTTP polling pattern, see the HTTP async operation tracking documentation.

Status van exemplaar ophalenGet instance status

Hiermee wordt de status van een opgegeven Orchestrator-exemplaar opgehaald.Gets the status of a specified orchestration instance.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

GET /admin/extensions/DurableTaskExtension/instances/{instanceId}
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &showHistory=[true|false]
    &showHistoryOutput=[true|false]
    &showInput=[true|false]

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

GET /runtime/webhooks/durabletask/instances/{instanceId}
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &showHistory=[true|false]
    &showHistoryOutput=[true|false]
    &showInput=[true|false]

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meters:Request parameters for this API include the default set mentioned previously as well as the following unique parameters:

VeldField ParametertypeParameter type DescriptionDescription
instanceId URLURL De ID van het Orchestration-exemplaar.The ID of the orchestration instance.
showInput QuerytekenreeksQuery string Optionele para meter.Optional parameter. Als deze optie falseis ingesteld op, wordt de functie-invoer niet opgenomen in de nettolading van het antwoord.If set to false, the function input will not be included in the response payload.
showHistory QuerytekenreeksQuery string Optionele para meter.Optional parameter. Als deze is trueingesteld op, wordt de geschiedenis van de Orchestration-uitvoering opgenomen in de nettolading van de reactie.If set to true, the orchestration execution history will be included in the response payload.
showHistoryOutput QuerytekenreeksQuery string Optionele para meter.Optional parameter. Als deze optie trueis ingesteld op, worden de functie-uitvoer opgenomen in de geschiedenis van de Orchestration-uitvoering.If set to true, the function outputs will be included in the orchestration execution history.
createdTimeFrom QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt de lijst met geretourneerde exemplaren die zijn gemaakt op of na de opgegeven ISO8601-tijds tempel gefilterd.When specified, filters the list of returned instances that were created at or after the given ISO8601 timestamp.
createdTimeTo QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt de lijst met geretourneerde exemplaren die zijn gemaakt op of vóór de opgegeven ISO8601-tijds tempel gefilterd.When specified, filters the list of returned instances that were created at or before the given ISO8601 timestamp.
runtimeStatus QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt indien opgegeven de lijst met geretourneerde instanties gefilterd op basis van de runtime status.When specified, filters the list of returned instances based on their runtime status. Zie het artikel querying instances voor een lijst met mogelijke runtime status waarden.To see the list of possible runtime status values, see the Querying instances article.

AntwoordResponse

Er kunnen verschillende mogelijke status code waarden worden geretourneerd.Several possible status code values can be returned.

  • HTTP 200 (OK) : Het opgegeven exemplaar heeft de status voltooid.HTTP 200 (OK): The specified instance is in a completed state.
  • HTTP 202 (geaccepteerd) : Het opgegeven exemplaar wordt uitgevoerd.HTTP 202 (Accepted): The specified instance is in progress.
  • HTTP 400 (ongeldige aanvraag) : Het opgegeven exemplaar is mislukt of beëindigd.HTTP 400 (Bad Request): The specified instance failed or was terminated.
  • HTTP 404 (niet gevonden) : Het opgegeven exemplaar bestaat niet of is niet gestart.HTTP 404 (Not Found): The specified instance doesn't exist or has not started running.
  • HTTP 500 (interne server fout) : Het opgegeven exemplaar is mislukt vanwege een onverwerkte uitzonde ring.HTTP 500 (Internal Server Error): The specified instance failed with an unhandled exception.

De nettolading van de reactie voor de http 200- en http 202 -CASEs is een JSON-object met de volgende velden:The response payload for the HTTP 200 and HTTP 202 cases is a JSON object with the following fields:

VeldField GegevenstypeData type DescriptionDescription
runtimeStatus stringstring De runtime status van het exemplaar.The runtime status of the instance. Waarden zijn onder andere actief, in behandeling, mislukt, geannuleerd, beëindigd, voltooid.Values include Running, Pending, Failed, Canceled, Terminated, Completed.
input JSONJSON De JSON-gegevens die worden gebruikt voor het initialiseren van het exemplaar.The JSON data used to initialize the instance. Dit veld is null als de showInput query teken reeks parameter is ingesteld falseop.This field is null if the showInput query string parameter is set to false.
customStatus JSONJSON De JSON-gegevens die worden gebruikt voor de aangepaste indelings status.The JSON data used for custom orchestration status. Dit veld is null niet ingesteld.This field is null if not set.
output JSONJSON De JSON-uitvoer van het exemplaar.The JSON output of the instance. Dit veld is null een niet-voltooide status van het exemplaar.This field is null if the instance is not in a completed state.
createdTime stringstring Het tijdstip waarop het exemplaar is gemaakt.The time at which the instance was created. Maakt gebruik van ISO 8601 Extended-notatie.Uses ISO 8601 extended notation.
lastUpdatedTime stringstring Het tijdstip waarop het exemplaar het laatst is bewaard.The time at which the instance last persisted. Maakt gebruik van ISO 8601 Extended-notatie.Uses ISO 8601 extended notation.
historyEvents JSONJSON Een JSON-matrix met de geschiedenis van de Orchestration-uitvoering.A JSON array containing the orchestration execution history. Dit veld is null tenzij de showHistory query teken reeks parameter is ingesteld trueop.This field is null unless the showHistory query string parameter is set to true.

Hier volgt een voor beeld van een nettolading met de geschiedenis van de Orchestration-uitvoering en uitvoer van de activiteit (opgemaakt voor de Lees baarheid):Here is an example response payload including the orchestration execution history and activity outputs (formatted for readability):

{
  "createdTime": "2018-02-28T05:18:49Z",
  "historyEvents": [
      {
          "EventType": "ExecutionStarted",
          "FunctionName": "E1_HelloSequence",
          "Timestamp": "2018-02-28T05:18:49.3452372Z"
      },
      {
          "EventType": "TaskCompleted",
          "FunctionName": "E1_SayHello",
          "Result": "Hello Tokyo!",
          "ScheduledTime": "2018-02-28T05:18:51.3939873Z",
          "Timestamp": "2018-02-28T05:18:52.2895622Z"
      },
      {
          "EventType": "TaskCompleted",
          "FunctionName": "E1_SayHello",
          "Result": "Hello Seattle!",
          "ScheduledTime": "2018-02-28T05:18:52.8755705Z",
          "Timestamp": "2018-02-28T05:18:53.1765771Z"
      },
      {
          "EventType": "TaskCompleted",
          "FunctionName": "E1_SayHello",
          "Result": "Hello London!",
          "ScheduledTime": "2018-02-28T05:18:53.5170791Z",
          "Timestamp": "2018-02-28T05:18:53.891081Z"
      },
      {
          "EventType": "ExecutionCompleted",
          "OrchestrationStatus": "Completed",
          "Result": [
              "Hello Tokyo!",
              "Hello Seattle!",
              "Hello London!"
          ],
          "Timestamp": "2018-02-28T05:18:54.3660895Z"
      }
  ],
  "input": null,
  "customStatus": { "nextActions": ["A", "B", "C"], "foo": 2 },
  "lastUpdatedTime": "2018-02-28T05:18:54Z",
  "output": [
      "Hello Tokyo!",
      "Hello Seattle!",
      "Hello London!"
  ],
  "runtimeStatus": "Completed"
}

Het http 202- antwoord bevat ook een locatie antwoord header die verwijst naar dezelfde URL als statusQueryGetUri het eerder genoemde veld.The HTTP 202 response also includes a Location response header that references the same URL as the statusQueryGetUri field mentioned previously.

Status van alle instanties ophalenGet all instances status

U kunt ook een query uitvoeren op de status van alle instanties instanceId door de uit de aanvraag ' exemplaar status ophalen ' te verwijderen.You can also query the status of all instances by removing the instanceId from the 'Get instance status' request. In dit geval zijn de basis parameters hetzelfde als de Get-exemplaar status.In this case, the basic parameters are the same as the 'Get instance status'. Query reeks parameters voor filteren worden ook ondersteund.Query string parameters for filtering are also supported.

Een ding die u moet onthouden connection is code dat en is optioneel.One thing to remember is that connection and code are optional. Als u anonieme verificatie hebt voor de functie, code is dit niet vereist.If you have anonymous auth on the function, then code isn't required. Als u geen andere opslag connection string wilt gebruiken dan gedefinieerd in de app-instelling voor AzureWebJobsStorage, kunt u de teken reeks parameter voor de verbindings query veilig negeren.If you don't want to use a different storage connection string other than defined in the AzureWebJobsStorage app setting, then you can safely ignore the connection query string parameter.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

GET /admin/extensions/DurableTaskExtension/instances
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &createdTimeFrom={timestamp}
    &createdTimeTo={timestamp}
    &runtimeStatus={runtimeStatus1,runtimeStatus2,...}
    &showInput=[true|false]
    &top={integer}

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

GET /runtime/webhooks/durableTask/instances?
    taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &createdTimeFrom={timestamp}
    &createdTimeTo={timestamp}
    &runtimeStatus={runtimeStatus1,runtimeStatus2,...}
    &showInput=[true|false]
    &top={integer}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meters:Request parameters for this API include the default set mentioned previously as well as the following unique parameters:

VeldField ParametertypeParameter type DescriptionDescription
instanceId URLURL De ID van het Orchestration-exemplaar.The ID of the orchestration instance.
showInput QuerytekenreeksQuery string Optionele para meter.Optional parameter. Als deze optie falseis ingesteld op, wordt de functie-invoer niet opgenomen in de nettolading van het antwoord.If set to false, the function input will not be included in the response payload.
showHistory QuerytekenreeksQuery string Optionele para meter.Optional parameter. Als deze is trueingesteld op, wordt de geschiedenis van de Orchestration-uitvoering opgenomen in de nettolading van de reactie.If set to true, the orchestration execution history will be included in the response payload.
showHistoryOutput QuerytekenreeksQuery string Optionele para meter.Optional parameter. Als deze optie trueis ingesteld op, worden de functie-uitvoer opgenomen in de geschiedenis van de Orchestration-uitvoering.If set to true, the function outputs will be included in the orchestration execution history.
createdTimeFrom QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt de lijst met geretourneerde exemplaren die zijn gemaakt op of na de opgegeven ISO8601-tijds tempel gefilterd.When specified, filters the list of returned instances that were created at or after the given ISO8601 timestamp.
createdTimeTo QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt de lijst met geretourneerde exemplaren die zijn gemaakt op of vóór de opgegeven ISO8601-tijds tempel gefilterd.When specified, filters the list of returned instances that were created at or before the given ISO8601 timestamp.
runtimeStatus QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt indien opgegeven de lijst met geretourneerde instanties gefilterd op basis van de runtime status.When specified, filters the list of returned instances based on their runtime status. Zie het artikel querying instances voor een lijst met mogelijke runtime status waarden.To see the list of possible runtime status values, see the Querying instances article.
top QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt het aantal exemplaren dat door de query wordt geretourneerd, beperkt.When specified, limits the number of instances returned by the query.

AntwoordResponse

Hier volgt een voor beeld van reactie payloads, inclusief de indelings status (opgemaakt voor de Lees baarheid):Here is an example of response payloads including the orchestration status (formatted for readability):

[
    {
        "instanceId": "7af46ff000564c65aafbfe99d07c32a5",
        "runtimeStatus": "Completed",
        "input": null,
        "customStatus": null,
        "output": [
            "Hello Tokyo!",
            "Hello Seattle!",
            "Hello London!"
        ],
        "createdTime": "2018-06-04T10:46:39Z",
        "lastUpdatedTime": "2018-06-04T10:46:47Z"
    },
    {
        "instanceId": "80eb7dd5c22f4eeba9f42b062794321e",
        "runtimeStatus": "Running",
        "input": null,
        "customStatus": null,
        "output": null,
        "createdTime": "2018-06-04T15:18:28Z",
        "lastUpdatedTime": "2018-06-04T15:18:38Z"
    },
    {
        "instanceId": "9124518926db408ab8dfe84822aba2b1",
        "runtimeStatus": "Completed",
        "input": null,
        "customStatus": null,
        "output": [
            "Hello Tokyo!",
            "Hello Seattle!",
            "Hello London!"
        ],
        "createdTime": "2018-06-04T10:46:54Z",
        "lastUpdatedTime": "2018-06-04T10:47:03Z"
    },
    {
        "instanceId": "d100b90b903c4009ba1a90868331b11b",
        "runtimeStatus": "Pending",
        "input": null,
        "customStatus": null,
        "output": null,
        "createdTime": "2018-06-04T15:18:39Z",
        "lastUpdatedTime": "2018-06-04T15:18:39Z"
    }
]

Notitie

Deze bewerking kan erg duur zijn in Azure Storage I/O als er veel rijen in de tabel instanties zijn.This operation can be very expensive in terms of Azure Storage I/O if there are a lot of rows in the Instances table. Meer informatie over de exemplaar tabel vindt u in de documentatie over prestaties en schaal baarheid in Durable functions (Azure functions) .More details on Instance table can be found in the Performance and scale in Durable Functions (Azure Functions) documentation.

Als er meer resultaten bestaan, wordt in de reactie header een vervolg token geretourneerd.If more results exist, a continuation token is returned in the response header. De naam van de koptekst is x-ms-continuation-token.The name of the header is x-ms-continuation-token.

Als u de vervolg token waarde in de volgende aanvraag header instelt, kunt u de volgende pagina met resultaten ophalen.If you set continuation token value in the next request header, you can get the next page of results. Dit is ook x-ms-continuation-tokende naam van de aanvraag header.This name of the request header is also x-ms-continuation-token.

Geschiedenis van één exemplaar opschonenPurge single instance history

Hiermee verwijdert u de geschiedenis en gerelateerde artefacten voor een opgegeven Orchestration-exemplaar.Deletes the history and related artifacts for a specified orchestration instance.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

DELETE /admin/extensions/DurableTaskExtension/instances/{instanceId}
    ?taskHub={taskHub}
    &connection={connection}
    &code={systemKey}

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

DELETE /runtime/webhooks/durabletask/instances/{instanceId}
    ?taskHub={taskHub}
    &connection={connection}
    &code={systemKey}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meters:Request parameters for this API include the default set mentioned previously as well as the following unique parameters:

VeldField ParametertypeParameter type DescriptionDescription
instanceId URLURL De ID van het Orchestration-exemplaar.The ID of the orchestration instance.

AntwoordResponse

De volgende HTTP-status code waarden kunnen worden geretourneerd.The following HTTP status code values can be returned.

  • HTTP 200 (OK) : De exemplaar geschiedenis is verwijderd.HTTP 200 (OK): The instance history has been purged successfully.
  • HTTP 404 (niet gevonden) : Het opgegeven exemplaar bestaat niet.HTTP 404 (Not Found): The specified instance doesn't exist.

De nettolading van de reactie voor de HTTP 200- case is een JSON-object met het volgende veld:The response payload for the HTTP 200 case is a JSON object with the following field:

VeldField GegevenstypeData type DescriptionDescription
instancesDeleted integerinteger Het aantal verwijderde exemplaren.The number of instances deleted. Voor het geval van één exemplaar moet deze waarde altijd zijn 1.For the single instance case, this value should always be 1.

Hier volgt een voor beeld van een Payload-reactie (opgemaakt voor de Lees baarheid):Here is an example response payload (formatted for readability):

{
    "instancesDeleted": 1
}

Meerdere exemplaar geschiedenissen verwijderenPurge multiple instance histories

U kunt ook de geschiedenis en gerelateerde artefacten voor meerdere exemplaren binnen een taak hub verwijderen door de {instanceId} uit de aanvraag verwijderen van één exemplaar van de geschiedenis te verwijderen.You can also delete the history and related artifacts for multiple instances within a task hub by removing the {instanceId} from the 'Purge single instance history' request. Als u de instantie geschiedenis selectief wilt opschonen, gebruikt u dezelfde filters die in de aanvraag ' alle instanties ophalen ' worden beschreven.To selectively purge instance history, use the same filters described in the 'Get all instances status' request.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

DELETE /admin/extensions/DurableTaskExtension/instances
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &createdTimeFrom={timestamp}
    &createdTimeTo={timestamp}
    &runtimeStatus={runtimeStatus1,runtimeStatus2,...}

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

DELETE /runtime/webhooks/durabletask/instances
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &createdTimeFrom={timestamp}
    &createdTimeTo={timestamp}
    &runtimeStatus={runtimeStatus1,runtimeStatus2,...}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meters:Request parameters for this API include the default set mentioned previously as well as the following unique parameters:

VeldField ParametertypeParameter type DescriptionDescription
createdTimeFrom QuerytekenreeksQuery string Hiermee wordt de lijst met verwijderde exemplaren gefilterd die zijn gemaakt op of na de opgegeven ISO8601-tijds tempel.Filters the list of purged instances that were created at or after the given ISO8601 timestamp.
createdTimeTo QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt de lijst met verwijderde exemplaren die zijn gemaakt op of vóór de opgegeven ISO8601-tijds tempel gefilterd.When specified, filters the list of purged instances that were created at or before the given ISO8601 timestamp.
runtimeStatus QuerytekenreeksQuery string Optionele para meter.Optional parameter. Hiermee wordt indien opgegeven de lijst met verwijderde exemplaren gefilterd op basis van de runtime status.When specified, filters the list of purged instances based on their runtime status. Zie het artikel querying instances voor een lijst met mogelijke runtime status waarden.To see the list of possible runtime status values, see the Querying instances article.

Notitie

Deze bewerking kan erg kostbaar zijn in termen van Azure Storage I/O als er veel rijen in de tabellen instanties en/of geschiedenis zijn.This operation can be very expensive in terms of Azure Storage I/O if there are a lot of rows in the Instances and/or History tables. Meer informatie over deze tabellen vindt u in de documentatie over prestaties en schaal baarheid in Durable functions (Azure functions) .More details on these tables can be found in the Performance and scale in Durable Functions (Azure Functions) documentation.

AntwoordResponse

De volgende HTTP-status code waarden kunnen worden geretourneerd.The following HTTP status code values can be returned.

  • HTTP 200 (OK) : De exemplaar geschiedenis is verwijderd.HTTP 200 (OK): The instance history has been purged successfully.
  • HTTP 404 (niet gevonden) : Er zijn geen exemplaren gevonden die overeenkomen met de filter expressie.HTTP 404 (Not Found): No instances were found that match the filter expression.

De nettolading van de reactie voor de HTTP 200- case is een JSON-object met het volgende veld:The response payload for the HTTP 200 case is a JSON object with the following field:

VeldField GegevenstypeData type DescriptionDescription
instancesDeleted integerinteger Het aantal verwijderde exemplaren.The number of instances deleted.

Hier volgt een voor beeld van een Payload-reactie (opgemaakt voor de Lees baarheid):Here is an example response payload (formatted for readability):

{
    "instancesDeleted": 250
}

Gebeurtenis verhogenRaise event

Hiermee verzendt u een bericht over gebeurtenis meldingen naar een actief Orchestration-exemplaar.Sends an event notification message to a running orchestration instance.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

POST /admin/extensions/DurableTaskExtension/instances/{instanceId}/raiseEvent/{eventName}
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

POST /runtime/webhooks/durabletask/instances/{instanceId}/raiseEvent/{eventName}
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meters:Request parameters for this API include the default set mentioned previously as well as the following unique parameters:

VeldField ParametertypeParameter type DescriptionDescription
instanceId URLURL De ID van het Orchestration-exemplaar.The ID of the orchestration instance.
eventName URLURL De naam van de gebeurtenis waarop het doel exemplaar van de Orchestrator-instantie wacht.The name of the event that the target orchestration instance is waiting on.
{content} Inhoud van aanvraagRequest content De nettolading van de JSON-indeling.The JSON-formatted event payload.

AntwoordResponse

Er kunnen verschillende mogelijke status code waarden worden geretourneerd.Several possible status code values can be returned.

  • HTTP 202 (geaccepteerd) : De verhoogde gebeurtenis is geaccepteerd voor verwerking.HTTP 202 (Accepted): The raised event was accepted for processing.
  • HTTP 400 (ongeldige aanvraag) : De inhoud van de aanvraag is niet application/json van het type of is geen geldige JSON.HTTP 400 (Bad request): The request content was not of type application/json or was not valid JSON.
  • HTTP 404 (niet gevonden) : Het opgegeven exemplaar is niet gevonden.HTTP 404 (Not Found): The specified instance was not found.
  • HTTP 410 (verdwenen) : Het opgegeven exemplaar is voltooid of mislukt en kan geen geactiveerde gebeurtenissen verwerken.HTTP 410 (Gone): The specified instance has completed or failed and cannot process any raised events.

Hier volgt een voorbeeld aanvraag waarmee de JSON-teken "incr" reeks wordt verzonden naar een instantie die wacht op een gebeurtenis bewerkingmet de naam:Here is an example request that sends the JSON string "incr" to an instance waiting for an event named operation:

POST /admin/extensions/DurableTaskExtension/instances/bcf6fb5067b046fbb021b52ba7deae5a/raiseEvent/operation?taskHub=DurableFunctionsHub&connection=Storage&code=XXX
Content-Type: application/json
Content-Length: 6

"incr"

De antwoorden voor deze API bevatten geen inhoud.The responses for this API do not contain any content.

Exemplaar beëindigenTerminate instance

Hiermee beëindigt u een actief Orchestration-exemplaar.Terminates a running orchestration instance.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

POST /admin/extensions/DurableTaskExtension/instances/{instanceId}/terminate
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &reason={text}

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

POST /runtime/webhooks/durabletask/instances/{instanceId}/terminate
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &reason={text}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meter.Request parameters for this API include the default set mentioned previously as well as the following unique parameter.

VeldField ParametertypeParameter Type DescriptionDescription
instanceId URLURL De ID van het Orchestration-exemplaar.The ID of the orchestration instance.
reason QuerytekenreeksQuery string Optioneel.Optional. De reden voor het beëindigen van het Orchestrator-exemplaar.The reason for terminating the orchestration instance.

AntwoordResponse

Er kunnen verschillende mogelijke status code waarden worden geretourneerd.Several possible status code values can be returned.

  • HTTP 202 (geaccepteerd) : De aanvraag voor het beëindigen is geaccepteerd voor verwerking.HTTP 202 (Accepted): The terminate request was accepted for processing.
  • HTTP 404 (niet gevonden) : Het opgegeven exemplaar is niet gevonden.HTTP 404 (Not Found): The specified instance was not found.
  • HTTP 410 (verdwenen) : Het opgegeven exemplaar is voltooid of mislukt.HTTP 410 (Gone): The specified instance has completed or failed.

Hier volgt een voorbeeld aanvraag waarmee een actief exemplaar wordt beëindigd en een reden voor het uitvoeren van foutenwordt opgegeven:Here is an example request that terminates a running instance and specifies a reason of buggy:

POST /admin/extensions/DurableTaskExtension/instances/bcf6fb5067b046fbb021b52ba7deae5a/terminate?reason=buggy&taskHub=DurableFunctionsHub&connection=Storage&code=XXX

De antwoorden voor deze API bevatten geen inhoud.The responses for this API do not contain any content.

Exemplaar terugspoelen (preview-versie)Rewind instance (preview)

Hiermee herstelt u een mislukte Orchestrator-instantie in een actieve status door de meest recente mislukte bewerkingen te herhalen.Restores a failed orchestration instance into a running state by replaying the most recent failed operations.

AanvraagRequest

Voor versie 1. x van de functions-runtime wordt de aanvraag als volgt opgemaakt (er worden meerdere lijnen weer gegeven voor duidelijkheid):For version 1.x of the Functions runtime, the request is formatted as follows (multiple lines are shown for clarity):

POST /admin/extensions/DurableTaskExtension/instances/{instanceId}/rewind
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &reason={text}

In versie 2. x van de functions runtime heeft de URL-indeling dezelfde para meters, maar met een iets ander voor voegsel:In version 2.x of the Functions runtime, the URL format has all the same parameters but with a slightly different prefix:

POST /runtime/webhooks/durabletask/instances/{instanceId}/rewind
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &reason={text}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meter.Request parameters for this API include the default set mentioned previously as well as the following unique parameter.

VeldField ParametertypeParameter Type DescriptionDescription
instanceId URLURL De ID van het Orchestration-exemplaar.The ID of the orchestration instance.
reason QuerytekenreeksQuery string Optioneel.Optional. De reden voor het terugspoelen van het Orchestration-exemplaar.The reason for rewinding the orchestration instance.

AntwoordResponse

Er kunnen verschillende mogelijke status code waarden worden geretourneerd.Several possible status code values can be returned.

  • HTTP 202 (geaccepteerd) : De aanvraag voor terugspoelen is geaccepteerd voor verwerking.HTTP 202 (Accepted): The rewind request was accepted for processing.
  • HTTP 404 (niet gevonden) : Het opgegeven exemplaar is niet gevonden.HTTP 404 (Not Found): The specified instance was not found.
  • HTTP 410 (verdwenen) : Het opgegeven exemplaar is voltooid of beëindigd.HTTP 410 (Gone): The specified instance has completed or was terminated.

Hier volgt een voorbeeld aanvraag voor het terugspoelen van een mislukt exemplaar en de reden van een vast:Here is an example request that rewinds a failed instance and specifies a reason of fixed:

POST /admin/extensions/DurableTaskExtension/instances/bcf6fb5067b046fbb021b52ba7deae5a/rewind?reason=fixed&taskHub=DurableFunctionsHub&connection=Storage&code=XXX

De antwoorden voor deze API bevatten geen inhoud.The responses for this API do not contain any content.

Signaal entiteitSignal entity

Verzendt een eenrichtings bewerkings bericht naar een duurzame entiteit.Sends a one-way operation message to a Durable Entity. Als de entiteit niet bestaat, wordt deze automatisch gemaakt.If the entity doesn't exist, it will be created automatically.

Notitie

Duurzame entiteiten zijn beschikbaar vanaf Durable Functions 2,0.Durable Entities are available starting in Durable Functions 2.0.

AanvraagRequest

De HTTP-aanvraag wordt als volgt ingedeeld (er worden meerdere regels weer gegeven voor de duidelijkheid):The HTTP request is formatted as follows (multiple lines are shown for clarity):

POST /runtime/webhooks/durabletask/entities/{entityType}/{entityKey}
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}
    &op={operationName}

Aanvraag parameters voor deze API zijn de standaardset die eerder is vermeld, evenals de volgende unieke para meters:Request parameters for this API include the default set mentioned previously as well as the following unique parameters:

VeldField ParametertypeParameter type DescriptionDescription
entityType URLURL Het type van de entiteit.The type of the entity.
entityKey URLURL De unieke naam van de entiteit.The unique name of the entity.
op QuerytekenreeksQuery string Optioneel.Optional. De naam van de door de gebruiker gedefinieerde bewerking die moet worden aangeroepen.The name of the user-defined operation to invoke.
{content} Inhoud van aanvraagRequest content De nettolading van de JSON-indeling.The JSON-formatted event payload.

Hier volgt een voorbeeld aanvraag waarmee een door de gebruiker gedefinieerde "add"-bericht naar Counter een entiteit stepsmet de naam wordt verzonden.Here is an example request that sends a user-defined "Add" message to a Counter entity named steps. De inhoud van het bericht is de waarde 5.The content of the message is the value 5. Als de entiteit nog niet bestaat, wordt deze gemaakt door deze aanvraag:If the entity does not already exist, it will be created by this request:

POST /runtime/webhooks/durabletask/entities/Counter/steps?op=Add
Content-Type: application/json

5

AntwoordResponse

Deze bewerking heeft verschillende mogelijke reacties:This operation has several possible responses:

  • HTTP 202 (geaccepteerd) : De signaal bewerking is geaccepteerd voor asynchrone verwerking.HTTP 202 (Accepted): The signal operation was accepted for asynchronous processing.
  • HTTP 400 (ongeldige aanvraag) : De aanvraag inhoud is niet van het application/jsontype, is geen geldige JSON of heeft een ongeldige entityKey waarde.HTTP 400 (Bad request): The request content was not of type application/json, was not valid JSON, or had an invalid entityKey value.
  • HTTP 404 (niet gevonden) : De opgegeven entityType is niet gevonden.HTTP 404 (Not Found): The specified entityType was not found.

Een geslaagde HTTP-aanvraag bevat geen inhoud in het antwoord.A successful HTTP request does not contain any content in the response. Een mislukte HTTP-aanvraag kan fout informatie in JSON-indeling bevatten in de antwoord inhoud.A failed HTTP request may contain JSON-formatted error information in the response content.

Query-entiteitQuery entity

Hiermee wordt de status van de opgegeven entiteit opgehaald.Gets the state of the specified entity.

AanvraagRequest

De HTTP-aanvraag wordt als volgt ingedeeld (er worden meerdere regels weer gegeven voor de duidelijkheid):The HTTP request is formatted as follows (multiple lines are shown for clarity):

GET /runtime/webhooks/durabletask/entities/{entityType}/{entityKey}
    ?taskHub={taskHub}
    &connection={connectionName}
    &code={systemKey}

AntwoordResponse

Deze bewerking heeft twee mogelijke antwoorden:This operation has two possible responses:

  • HTTP 200 (OK) : De opgegeven entiteit bestaat al.HTTP 200 (OK): The specified entity exists.
  • HTTP 404 (niet gevonden) : Kan de opgegeven entiteit niet vinden.HTTP 404 (Not Found): The specified entity was not found.

Een geslaagd antwoord bevat de JSON-serialisatie status van de entiteit als de inhoud.A successful response contains the JSON-serialized state of the entity as its content.

VoorbeeldExample

In het volgende voor beeld van een HTTP-aanvraag wordt Counter de status stepsvan een bestaande entiteit met de naam:The following example HTTP request gets the state of an existing Counter entity named steps:

GET /runtime/webhooks/durabletask/entities/Counter/steps

Als de Counter entiteit simpelweg een aantal stappen bevat die zijn opgeslagen in currentValue een veld, kan de antwoord inhoud er als volgt uitzien (opgemaakt voor de Lees baarheid):If the Counter entity simply contained a number of steps saved in a currentValue field, the response content might look like the following (formatted for readability):

{
    "currentValue": 5
}

Volgende stappenNext steps