GetWebToolInfo

描述

获取诸如用于分析的网络数据集的说明以及在门户注册的路径实用程序服务中某一工具的执行限制。

讨论

GetWebToolInfo 可用于获取门户使用的网络数据源的工具限制或信息。

语法

GetWebToolInfo (service_name, tool_name, {portal_url})

参数	说明	数据类型
service_name	包含 web 工具的服务的名称。 有效值包括 asyncClosestFacility、asyncLocationAllocation、 asyncODCostMatrix、asyncRoute、asyncServiceArea、asyncVRP 和 syncVRP。以上值区分大小写。如果 service_name 值不在受支持值的列表中，则会发生 ValueError。	String
tool_name	Web 工具的名称。 有效值包括 EditVehicleRoutingProblem、FindClosestFacilities、FindRoutes、GenerateOriginDestinationCostMatrix、GenerateServiceAreas、SolveLocationAllocation 和 SolveVehicleRoutingProblem。以上值区分大小写。如果 tool_name 值不在受支持值的列表中，则会发生 ValueError。	String
portal_url	包含服务的门户的 URL。如果未指定值，则将使用活动门户 URL。 (默认值为 None)	String

返回值

数据类型	说明
Dictionary	关键字 值 networkDataset 提供有关 web 工具使用的网络数据集的信息 serviceLimits 提供对 web 工具的限制 GetWebToolInfo 字典对象关键字。

代码示例

GetWebToolInfo 示例 1

以下代码示例可显示如何从活动门户获取服务区实用程序服务支持的最大设施点数量。

# The following code sample shows how to get the maximum number of facilities supported by the Service Area utility
# service from your active portal.

import arcpy

# Get the active portal url
portal_url = arcpy.GetActivePortalURL()
print(f"Active portal: {portal_url}")

# Get the tool limits for the tool from the active portal
tool_info = arcpy.nax.GetWebToolInfo("asyncServiceArea", "GenerateServiceAreas")
max_facilities = tool_info["serviceLimits"]["maximumFacilities"]
print(f"Maximum facilities: {max_facilities}")

GetWebToolInfo 示例 2

以下代码示例可显示如何从网络数据源打印所有成本属性的流量支持类型。

# The following code sample shows how to print the traffic support type for all the cost attributes from your
# network data source.

import arcpy

# Get the active portal url
portal_url = arcpy.GetActivePortalURL()
print(f"Active portal: {portal_url}")

# Get the network dataset description from the active portal
tool_info = arcpy.nax.GetWebToolInfo("asyncRoute","FindRoutes")
nd_info = tool_info["networkDataset"]
for attribute in nd_info["networkAttributes"]:
    if attribute["usageType"] == "Cost":
        print(f"{attribute['name']}: {attribute['trafficSupport']}")