你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job Router Operations - Cancel Job

服务:

Communication

API 版本:

2023-11-01

提交按 ID 取消现有作业的请求，同时提供自由格式的取消原因。

POST {endpoint}/routing/jobs/{jobId}:cancel?api-version=2023-11-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	通信资源的 URI
jobId	path	True	string	作业的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	类型	说明
dispositionCode	string	指示作业的结果，用自己的自定义值填充此字段。 如果未提供，则设置默认值“已取消”。
note	string	将追加到具有当前时间戳的作业的 Notes 集合的注释。

响应

名称	类型	说明
200 OK	object	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

示例

Cancels a job

Submits request to cancel an existing job

Cancels a job

示例请求

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

{}

示例响应

状态代码:

200

{}

Submits request to cancel an existing job

示例请求

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

示例响应

状态代码:

200

{}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
CancelJobOptions	请求用于取消作业的有效负载。

Azure.Core.Foundations.Error

错误对象。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
details	Azure.Core.Foundations.Error[]	有关导致此项报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
innererror	Azure.Core.Foundations.InnerError	内部错误。

CancelJobOptions

请求用于取消作业的有效负载。

名称	类型	说明
dispositionCode	string	指示作业的结果，用自己的自定义值填充此字段。 如果未提供，则设置默认值“已取消”。
note	string	将追加到具有当前时间戳的作业的 Notes 集合的注释。