通过

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

Integration Runtimes - Get Status

  • 参考
服务:
Data Factory
API 版本:
2018-06-01

获取集成运行时的详细状态信息。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus?api-version=2018-06-01

URI 参数

名称 在 必需 类型 说明
factoryName
 path True

string

工厂名称。

正则表达式模式: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
integrationRuntimeName
 path True

string

集成运行时名称。

正则表达式模式: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName
 path True

string

资源组名称。

正则表达式模式: ^[-\w\._\(\)]+$
subscriptionId
 path True

string

订阅标识符。
api-version
 query True

string

API 版本。

响应

名称 类型 说明
200 OK

IntegrationRuntimeStatusResponse

没问题。
Other Status Codes

CloudError

从Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

IntegrationRuntimes_GetStatus

示例请求

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime/getStatus?api-version=2018-06-01

示例响应

状态代码:
200 
Date: Thu, 14 Jun 2018 14:53:22 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14997
x-ms-request-id: 19efe790-074f-4241-ae94-0422935d0f46
x-ms-correlation-request-id: 19efe790-074f-4241-ae94-0422935d0f46
{
  "name": "exampleIntegrationRuntime",
  "properties": {
    "state": "Online",
    "type": "SelfHosted",
    "typeProperties": {
      "autoUpdate": "Off",
      "taskQueueId": "1a6296ab-423c-4346-9bcc-85a78c2c0582",
      "version": "3.8.6730.2",
      "nodes": [
        {
          "nodeName": "Node_1",
          "machineName": "YANZHANG-DT",
          "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/",
          "status": "Online",
          "capabilities": {
            "serviceBusConnected": "True",
            "httpsPortEnabled": "True",
            "credentialInSync": "True",
            "connectedToResourceManager": "True",
            "nodeEnabled": "True"
          },
          "versionStatus": "UpToDate",
          "version": "3.8.6730.2",
          "registerTime": "2018-06-14T14:51:44.9237069Z",
          "lastConnectTime": "2018-06-14T14:52:59.8933313Z",
          "lastStartTime": "2018-06-14T14:52:59.8933313Z",
          "lastUpdateResult": "None",
          "isActiveDispatcher": true,
          "maxConcurrentJobs": 56
        }
      ],
      "updateDelayOffset": "PT3H",
      "localTimeZoneOffset": "PT8H",
      "serviceUrls": [
        "wu.frontend.int.clouddatahub-int.net",
        "*.servicebus.windows.net"
      ],
      "versionStatus": "UpToDate",
      "capabilities": {
        "serviceBusConnected": "True",
        "httpsPortEnabled": "True",
        "credentialInSync": "True",
        "connectedToResourceManager": "True",
        "nodeEnabled": "True"
      },
      "latestVersion": "3.7.6711.1",
      "createTime": "2018-06-14T09:17:45.1839685Z"
    }
  }
}

定义

名称 说明
CloudError

定义Azure 数据工厂错误响应结构的对象。
IntegrationRuntimeAutoUpdate

集成运行时自动更新的状态。
IntegrationRuntimeInternalChannelEncryptionMode

当) 存在 2 个以上的自承载集成运行时节点时，它用于设置节点-节点信道 (的加密模式。
IntegrationRuntimeState

集成运行时的状态。
IntegrationRuntimeStatusResponse

集成运行时状态响应。
IntegrationRuntimeType

集成运行时的类型。
IntegrationRuntimeUpdateResult

上次集成运行时节点更新的结果。
LinkedIntegrationRuntime

链接的集成运行时信息。
ManagedIntegrationRuntimeError

托管集成运行时的错误定义。
ManagedIntegrationRuntimeNode

集成运行时节点的属性。
ManagedIntegrationRuntimeNodeStatus

托管集成运行时节点状态。
ManagedIntegrationRuntimeOperationResult

托管集成运行时操作结果的属性。
ManagedIntegrationRuntimeStatus

托管集成运行时状态。
SelfHostedIntegrationRuntimeNode

自承载集成运行时节点的属性。
SelfHostedIntegrationRuntimeNodeStatus

集成运行时节点的状态。
SelfHostedIntegrationRuntimeStatus

自承载集成运行时状态。

CloudError

定义Azure 数据工厂错误响应结构的对象。

名称 类型 说明
error.code

string

错误代码。
error.details

CloudError[]

包含其他错误详细信息的数组。
error.message

string

错误消息。
error.target

string

与错误关联的请求中的属性名称/路径。

IntegrationRuntimeAutoUpdate

集成运行时自动更新的状态。

名称 类型 说明
Off

string

On

string

IntegrationRuntimeInternalChannelEncryptionMode

当) 存在 2 个以上的自承载集成运行时节点时，它用于设置节点-节点信道 (的加密模式。

名称 类型 说明
NotEncrypted

string

NotSet

string

SslEncrypted

string

IntegrationRuntimeState

集成运行时的状态。

名称 类型 说明
AccessDenied

string

Initial

string

Limited

string

NeedRegistration

string

Offline

string

Online

string

Started

string

Starting

string

Stopped

string

Stopping

string

IntegrationRuntimeStatusResponse

集成运行时状态响应。

名称 类型 说明
name

string

集成运行时名称。
properties IntegrationRuntimeStatus:

集成运行时属性。

IntegrationRuntimeType

集成运行时的类型。

名称 类型 说明
Managed

string

SelfHosted

string

IntegrationRuntimeUpdateResult

上次集成运行时节点更新的结果。

名称 类型 说明
Fail

string

None

string

Succeed

string

LinkedIntegrationRuntime

链接的集成运行时信息。

名称 类型 说明
createTime

string

链接集成运行时的创建时间。
dataFactoryLocation

string

链接集成运行时所属的数据工厂的位置。
dataFactoryName

string

链接集成运行时所属的数据工厂的名称。
name

string

链接集成运行时的名称。
subscriptionId

string

链接集成运行时所属的订阅 ID。

ManagedIntegrationRuntimeError

托管集成运行时的错误定义。

名称 类型 说明
code

string

错误代码。
message

string

错误消息。
parameters

string[]

托管集成运行时错误参数。
time

string

发生错误的时间。

ManagedIntegrationRuntimeNode

集成运行时节点的属性。

名称 类型 说明
errors

ManagedIntegrationRuntimeError[]

此集成运行时节点上发生的错误。
nodeId

string

托管集成运行时节点 ID。
status

ManagedIntegrationRuntimeNodeStatus

托管集成运行时节点状态。

ManagedIntegrationRuntimeNodeStatus

托管集成运行时节点状态。

名称 类型 说明
Available

string

Recycling

string

Starting

string

Unavailable

string

ManagedIntegrationRuntimeOperationResult

托管集成运行时操作结果的属性。

名称 类型 说明
activityId

string

操作请求的活动 ID。
errorCode

string

错误代码。
parameters

string[]

托管集成运行时错误参数。
result

string

操作结果。
startTime

string

操作的开始时间。
type

string

运算类型。 可以是启动或停止。

ManagedIntegrationRuntimeStatus

托管集成运行时状态。

名称 类型 说明
dataFactoryName

string

集成运行时所属的数据工厂名称。
state

IntegrationRuntimeState

集成运行时的状态。
type string:

Managed

集成运行时的类型。
typeProperties.createTime

string

以 ISO8601 格式创建集成运行时的时间。
typeProperties.lastOperation

ManagedIntegrationRuntimeOperationResult

此集成运行时上发生的最后一个操作结果。
typeProperties.nodes

ManagedIntegrationRuntimeNode[]

托管集成运行时的节点列表。
typeProperties.otherErrors

ManagedIntegrationRuntimeError[]

此集成运行时上发生的错误。

SelfHostedIntegrationRuntimeNode

自承载集成运行时节点的属性。

名称 类型 说明
capabilities

object

集成运行时功能字典
concurrentJobsLimit

integer

集成运行时节点上的最大并发作业数。
expiryTime

string

集成运行时将以 ISO8601 格式过期的时间。
hostServiceUri

string

集成运行时的主机的 URI。
isActiveDispatcher

boolean

指示此节点是否是集成运行时请求的活动调度程序。
lastConnectTime

string

集成运行时以ISO8601格式连接的最新时间。
lastEndUpdateTime

string

最后一次集成运行时节点更新结束。
lastStartTime

string

节点上次启动的时间。
lastStartUpdateTime

string

集成运行时节点更新的上次开始时间。
lastStopTime

string

集成运行时节点上次停止时间。
lastUpdateResult

IntegrationRuntimeUpdateResult

上次集成运行时节点更新的结果。
machineName

string

集成运行时节点的计算机名称。
maxConcurrentJobs

integer

此集成运行时中的最大并发作业数。
nodeName

string

集成运行时节点的名称。
registerTime

string

以 ISO8601 格式注册集成运行时节点的时间。
status

SelfHostedIntegrationRuntimeNodeStatus

集成运行时节点的状态。
version

string

集成运行时节点的版本。
versionStatus

string

集成运行时节点版本的状态。

SelfHostedIntegrationRuntimeNodeStatus

集成运行时节点的状态。

名称 类型 说明
InitializeFailed

string

Initializing

string

Limited

string

NeedRegistration

string

Offline

string

Online

string

Upgrading

string

SelfHostedIntegrationRuntimeStatus

自承载集成运行时状态。

名称 类型 说明
dataFactoryName

string

集成运行时所属的数据工厂名称。
state

IntegrationRuntimeState

集成运行时的状态。
type string:

SelfHosted

集成运行时的类型。
typeProperties.autoUpdate

IntegrationRuntimeAutoUpdate

是否已启用自承载集成运行时自动更新。
typeProperties.autoUpdateETA

string

自承载集成运行时的估计更新时间。
typeProperties.capabilities

object

包含有关集成运行时功能的其他信息的对象。
typeProperties.createTime

string

以 ISO8601 格式创建集成运行时的时间。
typeProperties.internalChannelEncryption

IntegrationRuntimeInternalChannelEncryptionMode

当) 存在 2 个以上的自承载集成运行时节点时，它用于设置节点-节点信道 (的加密模式。
typeProperties.latestVersion

string

下载中心上的最新版本。
typeProperties.links

LinkedIntegrationRuntime[]

创建用于与此集成运行时共享的链接集成运行时的列表。
typeProperties.localTimeZoneOffset

string

本地时区偏移量（以小时为单位）。
typeProperties.nodes

SelfHostedIntegrationRuntimeNode[]

此集成运行时的节点列表。
typeProperties.pushedVersion

string

集成运行时要更新到的版本。
typeProperties.scheduledUpdateDate

string

计划更新集成运行时的日期，采用ISO8601格式。
typeProperties.selfContainedInteractiveAuthoringEnabled

boolean

当自承载集成运行时无法与 Azure 中继建立连接时，确保交互式创作功能的另一个选项。
typeProperties.serviceUrls

string[]

集成运行时后端服务中使用的服务的 URL。
typeProperties.taskQueueId

string

集成运行时的任务队列 ID。
typeProperties.updateDelayOffset

string

服务计划更新集成运行时的日期中的时间，例如 PT03H 为 3 小时
typeProperties.version

string

集成运行时的版本。
typeProperties.versionStatus

string

集成运行时版本的状态。