Data Transfer Jobs - Cancel

服务:

Cosmos DB Resource Provider

API 版本:

2025-05-01-preview

取消数据传输作业。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/cancel?api-version=2025-05-01-preview

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 数据库帐户名称。
jobName	path	True	string	数据传输作业的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	DataTransferJobGetResults	成功取消作业响应
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟您的用户账户

示例

CosmosDBDataTransferJobCancel

示例请求

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/dataTransferJobs/j1/cancel?api-version=2025-05-01-preview

示例响应

状态代码:

200

{
  "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "properties": {
    "jobName": "j1",
    "source": {
      "tableName": "table",
      "keyspaceName": "keyspace",
      "component": "CosmosDBCassandra"
    },
    "destination": {
      "component": "AzureBlobStorage",
      "containerName": "blob_container",
      "endpointUrl": "https://blob.windows.net"
    },
    "status": "Cancelled",
    "processedCount": 20,
    "totalCount": 100,
    "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z",
    "duration": "00:34:10"
  }
}

定义

名称	说明
AzureBlobDataTransferDataSourceSink	Azure Blob 存储数据源/接收器
CloudError	服务的错误响应。
CosmosMongoVCoreDataTransferDataSourceSink	CosmosDB Mongo vCore API 数据源/接收器
DataTransferJobGetResults	Cosmos DB 数据传输作业
DataTransferJobMode	作业执行模式
ErrorResponse	错误响应。

AzureBlobDataTransferDataSourceSink

Object

Azure Blob 存储数据源/接收器

名称	类型	默认值	说明
component	string: AzureBlobStorage	CosmosDBCassandra
containerName	string
endpointUrl	string

CloudError

Object

服务的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应。

CosmosMongoVCoreDataTransferDataSourceSink

Object

CosmosDB Mongo vCore API 数据源/接收器

名称	类型	默认值	说明
collectionName	string
component	string: CosmosDBMongoVCore	CosmosDBCassandra
connectionStringKeyVaultUri	string
databaseName	string
hostName	string

DataTransferJobGetResults

Object

Cosmos DB 数据传输作业

名称	类型	说明
id	string	数据库帐户的唯一资源标识符。
name	string	数据库帐户的名称。
properties.destination	DataTransferDataSourceSink: AzureBlobDataTransferDataSourceSink CosmosMongoVCoreDataTransferDataSourceSink	目标数据存储详细信息
properties.duration	string	作业总持续时间
properties.error	ErrorResponse	出错作业的错误响应
properties.jobName	string	作业名称
properties.lastUpdatedUtcTime	string (date-time)	上次更新时间（ISO-8601 格式）。
properties.mode	DataTransferJobMode	作业执行模式
properties.processedCount	integer (int64)	已处理计数。
properties.source	DataTransferDataSourceSink: AzureBlobDataTransferDataSourceSink CosmosMongoVCoreDataTransferDataSourceSink	源 DataStore 详细信息
properties.status	string	工作状态
properties.totalCount	integer (int64)	总计计数。
properties.workerCount	integer (int32) minimum: 0	辅助角色计数
type	string	Azure 资源的类型。

DataTransferJobMode

枚举

作业执行模式

值	说明
Offline
Online

ErrorResponse

Object

错误响应。

名称	类型	说明
code	string	错误代码。
message	string	指示作失败的原因的错误消息。