上传服务定义 (服务器工具)

汇总

将 Web 图层、定位器、Web 工具、服务或知识图谱上传并共享至 ArcGIS Online、ArcGIS Enterprise 或 ArcGIS Server。

用法

该工具可以根据输入服务定义上传并共享 Web 图层、定位器、Web 工具、服务或知识图谱。
该工具不能上传或共享服务定义草稿文件 (.sddraft)。如果您有服务定义草稿，则您可以使用过渡服务 工具将其转换成过渡的服务定义。
Web 工具只能共享至 ArcGIS Enterprise。地理处理服务只能发布到 ArcGIS Server。
定位器只能共享至 ArcGIS Enterprise。地理编码服务只能发布到 ArcGIS Server。
知识图谱仅可以共享至 ArcGIS Enterprise 12.0 或更高版本。
将以下内容共享到相应 ArcGIS Enterprise 版本时，可以指定项目 ID：
- Web feature layer that copies all data—ArcGIS Enterprise 10.8.1 或更高版本
- Web tile layer—ArcGIS Enterprise 10.8.1 或更高版本
- Map image layer—ArcGIS Enterprise 11.2 或更高版本
- Web feature layer that references registered data—ArcGIS Enterprise 11.2 或更高版本
- OGC feature layer—ArcGIS Enterprise 11.2 或更高版本
- WMS service layer—ArcGIS Enterprise 11.2 或更高版本
- WFS service layer—ArcGIS Enterprise 11.2 或更高版本
- Knowledge graphs—ArcGIS Enterprise 12.0 或更高版本

标注	说明	数据类型
服务定义	服务定义文件 (`.sd`) 包含共享 Web 图层、定位器、Web 工具、服务或知识图谱所需的所有信息。	File
服务器	服务器类型。支持的服务器类型如下： My Hosted Services—将托管的 Web 图层共享至 ArcGIS Online 或 ArcGIS Enterprise 时使用。针对服务器连接，输入我的托管服务。将每个单词的第一个字母大写，并且在每个单词之间包含空格。 HOSTING_SERVER—将托管的 Web 图层共享至 ArcGIS Online 或 ArcGIS Enterprise 时使用。 URL to the ArcGIS Enterprise portal federated server—将 Web 工具或地图图像图层共享到 ArcGIS Enterprise 门户联合服务器时使用。 ArcGIS Server connection—将地图或地理处理服务共享到 ArcGIS Server 时使用。您可以使用在工程窗口中服务器节点下列出的 ArcGIS Server 连接，也可以浏览至存储服务器连接文件的文件夹。 URL to ArcGIS Server—将地图或地理处理服务共享到 ArcGIS Server 时使用。如果您已将 ArcGIS Server 的发布者连接添加到 ArcGIS Pro 工程，且您正使用脚本打开工程或正在 ArcGIS Pro 中运行工具，则您可以指定 ArcGIS Server 的 URL。 KNOWLEDGE_SERVER—将知识图谱共享至 ArcGIS Enterprise 12.0 或更高版本时使用。	ServerConnection
服务名称（可选）	此服务名称将覆盖服务定义中指定的当前服务名称。	String
集群（可选）	集群名称将覆盖已为其分配服务的当前集群。您必须从指定服务器上的集群中选择。旧版本： ArcGIS Enterprise 10.5.1 中已弃用了集群。对于不支持多个集群的服务器，此参数将被忽略。	String
文件夹类型（可选）	指定将用于确定文件夹来源的文件夹类型。默认设置是来自服务定义的文件夹。您还可以获取指定在线服务器上的现有文件夹列表，或者可以在共享此 Web 图层、服务或知识图谱时指定创建新的文件夹。新建—将创建新文件夹。现有—将使用服务器上的现有文件夹。从服务定义—将使用服务定义中的文件夹。这是默认设置。	String
文件夹（可选）	该文件夹将用于 web 图层、服务或知识图谱。如果未提供文件夹，则将使用服务定义中指定的文件夹。如果将文件夹类型指定为新建，则使用此参数来提供文件夹名称。如果将文件夹类型指定为现有，则可从服务器上的现有文件夹中选择。	String
立即启动服务（可选）	指定共享后是否将启动服务。选中—该服务在共享之后启动。这是默认设置。未选中—该服务在共享之后不会启动。	Boolean
覆盖服务定义共享属性（可选）	指定是否覆盖服务定义中设置的共享属性。这些属性定义了您是否正在与 ArcGIS Online 或 ArcGIS Enterprise 共享 Web 图层、Web 工具或知识图谱以及共享的方式。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。选中—将覆盖服务定义中设置的共享属性。未选中—不覆盖服务定义中设置的共享属性。这是默认设置。	Boolean
在 ArcGIS Online 上共享（可选）	指定是否共享 web 图层、web 工具或知识图谱。所有共享 Web 图层、Web 工具或知识图谱均可通过我的内容提供。即使您只想与组织中的某一特定群组共享，该 Web 图层、Web 工具或知识图谱也会通过我的内容共享。要覆盖共享属性，您必须登录门户。共享到 ArcGIS Server 时，不支持此参数。选中—您的内容将在 ArcGIS Online 或 ArcGIS Enterprise 上进行共享。该 Web 图层、Web 工具或知识图谱将在我的内容下列出。未选中—您的内容不会在 ArcGIS Online 或 ArcGIS Enterprise 上进行共享，且其他 ArcGIS Online 或 ArcGIS Enterprise 用户及 Web 客户端将无法访问该内容。这是默认设置。	Boolean
共享给所有人（公共）（可选）	指定是否向公众提供 web 图层或 Web 工具。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。共享知识图谱时不支持该参数。选中—向公众提供您的内容。未选中—不向公众提供您的内容。这是默认设置。	Boolean
与您的组织共享（可选）	指定是否将 web 图层、 Web 工具或知识图谱与您所在的组织共享。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。选中—您的内容将共享给您所在的组织。未选中—您的内容将不共享给您所在的组织。这是默认设置。	Boolean
与这些群组共享（可选）	指定是否将 web 图层、 Web 工具或知识图谱与您所在的组织内的指定群组共享。 Checked—与指定群组共享您的内容。 Unchecked—不与指定群组共享您的内容。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。	String
输出项目 ID （可选）	指定输入服务定义中准备好的输出 Web 图层或知识图谱的项目 ID。可以为每个项目指定一个项目 ID。 ID 必须可用，并且包含 32 个字母数字值，范围包含字母 a 到 f 和数字 0 到 9。如果未提供 ID，将自动创建一个项目 ID。可以为以下项目指定项目 ID： Web 要素图层—ArcGIS Enterprise 10.8.1 或更高版本 Web 切片图层—ArcGIS Enterprise 10.8.1 或更高版本地图图像图层—ArcGIS Enterprise 11.2 或更高版本 OGC 要素图层—ArcGIS Enterprise 11.2 或更高版本 WMS—ArcGIS Enterprise 11.2 或更高版本 WFS—ArcGIS Enterprise 11.2 或更高版本知识图谱—ArcGIS Enterprise 12.0 或更高版本如果服务定义设置为覆盖现有服务，或者提供了 ArcGIS Server 连接或 ArcGIS Server URL，则此参数不可用。值表列： Item Type—The item type. Item ID—The item IDs of the output web layers staged in the input service definition.	Value Table

派生输出

标注	说明	数据类型
SOAP 服务 URL	发布到服务器的服务的 SOAP URL。	String
REST 服务 URL	发布到服务器的服务的 REST URL。	String
托管地图服务项 ID	共享到门户的地图影像图层的项目 ID。	String
托管要素服务项 ID	共享到门户的托管要素服务图层的项目 ID。	String
缓存服务	启用缓存的影像服务或地图服务。	Image Service; Map Server
要素服务 URL	共享到门户的托管要素图层的 REST URL。	String
地图服务 URL	共享到门户的地图影像图层的 REST URL。	String
图层 ID	已发布图层及其各自的 ID 采用 Layer1\|ID1;Layer2\|ID2; 的格式，以此类推。	String
服务 URL	已发布独立表及其各自的 ID 采用 Table1\|ID1;Table2\|ID2; 的格式，以此类推。	String
托管矢量切片服务项 ID	矢量切片服务的项目 ID。	String
矢量切片服务 URL	矢量切片服务的 REST URL。	String
项目 ID	web 项目的项目 ID 共享至门户。项目 ID 将包含以下字符串之一： `web_feature_layer_id` `web_tile_layer_id` `map_image_layer_id` `ogc_feature_layer_id` `wms_id` `wfs_id` `knowledge_graph_id`	Value Table

arcpy.server.UploadServiceDefinition(in_sd_file, in_server, {in_service_name}, {in_cluster}, {in_folder_type}, {in_folder}, {in_startupType}, {in_override}, {in_my_contents}, {in_public}, {in_organization}, {in_groups}, {in_item_id})

名称	说明	数据类型
in_sd_file	服务定义文件 (`.sd`) 包含共享 Web 图层、定位器、Web 工具、服务或知识图谱所需的所有信息。	File
in_server	服务器类型。支持的服务器类型如下： My Hosted Services—将托管的 Web 图层共享至 ArcGIS Online 或 ArcGIS Enterprise 时使用。针对服务器连接，输入我的托管服务。将每个单词的第一个字母大写，并且在每个单词之间包含空格。 HOSTING_SERVER—将托管的 Web 图层共享至 ArcGIS Online 或 ArcGIS Enterprise 时使用。 URL to the ArcGIS Enterprise portal federated server—将 Web 工具或地图图像图层共享到 ArcGIS Enterprise 门户联合服务器时使用。 ArcGIS Server connection—将地图或地理处理服务共享到 ArcGIS Server 时使用。您可以使用在工程窗口中服务器节点下列出的 ArcGIS Server 连接，也可以浏览至存储服务器连接文件的文件夹。 URL to ArcGIS Server—将地图或地理处理服务共享到 ArcGIS Server 时使用。如果您已将 ArcGIS Server 的发布者连接添加到 ArcGIS Pro 工程，且您正使用脚本打开工程或正在 ArcGIS Pro 中运行工具，则您可以指定 ArcGIS Server 的 URL。 KNOWLEDGE_SERVER—将知识图谱共享至 ArcGIS Enterprise 12.0 或更高版本时使用。	ServerConnection
in_service_name （可选）	此服务名称将覆盖服务定义中指定的当前服务名称。	String
in_cluster （可选）	集群名称将覆盖已为其分配服务的当前集群。您必须从指定服务器上的集群中选择。旧版本： ArcGIS Enterprise 10.5.1 中已弃用了集群。对于不支持多个集群的服务器，此参数将被忽略。	String
in_folder_type （可选）	指定将用于确定文件夹来源的文件夹类型。默认设置是来自服务定义的文件夹。您还可以获取指定在线服务器上的现有文件夹列表，或者可以在共享此 Web 图层、服务或知识图谱时指定创建新的文件夹。 `NEW`—将创建新文件夹。 `EXISTING`—将使用服务器上的现有文件夹。 `FROM_SERVICE_DEFINITION`—将使用服务定义中的文件夹。这是默认设置。	String
in_folder （可选）	该文件夹将用于 web 图层、服务或知识图谱。如果未提供文件夹，则将使用服务定义中指定的文件夹。如果您将 `in_folder_type` 指定为 `NEW`，则使用此参数来提供文件夹名称。如果您将 `in_folder_type` 指定为 `EXISTING`，则可从服务器上的现有文件夹中选择。	String
in_startupType （可选）	指定共享后是否将启动服务。 `STARTED`—该服务在共享之后启动。这是默认设置。 `STOPPED`—该服务在共享之后不会启动。	Boolean
in_override （可选）	指定是否覆盖服务定义中设置的共享属性。这些属性定义了您是否正在与 ArcGIS Online 或 ArcGIS Enterprise 共享 Web 图层、Web 工具或知识图谱以及共享的方式。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。 `OVERRIDE_DEFINITION`—将覆盖服务定义中设置的共享属性。 `USE_DEFINITION`—不覆盖服务定义中设置的共享属性。这是默认设置。	Boolean
in_my_contents （可选）	指定是否共享 web 图层、web 工具或知识图谱。所有共享 Web 图层、Web 工具或知识图谱均可通过我的内容提供。即使您只想与组织中的某一特定群组共享，该 Web 图层、Web 工具或知识图谱也会通过我的内容共享。要覆盖共享属性，您必须登录门户。共享到 ArcGIS Server 时，不支持此参数。 `SHARE_ONLINE`—您的内容将在 ArcGIS Online 或 ArcGIS Enterprise 上进行共享。该 Web 图层、Web 工具或知识图谱将在我的内容下列出。 `NO_SHARE_ONLINE`—您的内容不会在 ArcGIS Online 或 ArcGIS Enterprise 上进行共享，且其他 ArcGIS Online 或 ArcGIS Enterprise 用户及 Web 客户端将无法访问该内容。这是默认设置。	Boolean
in_public （可选）	指定是否向公众提供 web 图层或 Web 工具。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。共享知识图谱时不支持该参数。 `PUBLIC`—向公众提供您的内容。 `PRIVATE`—不向公众提供您的内容。这是默认设置。	Boolean
in_organization （可选）	指定是否将 web 图层、 Web 工具或知识图谱与您所在的组织共享。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。 `SHARE_ORGANIZATION`—您的内容将共享给您所在的组织。 `NO_SHARE_ORGANIZATION`—您的内容将不共享给您所在的组织。这是默认设置。	Boolean
in_groups [in_groups,...] （可选）	要与之共享 Web 图层、 Web 工具或知识图谱的群组的名称列表。要覆盖共享属性，您必须登录 ArcGIS Online 或 ArcGIS Enterprise。共享到 ArcGIS Server 时，不支持此参数。	String
in_item_id [in_item_id,...] （可选）	指定输入服务定义中准备好的输出 Web 图层或知识图谱的项目 ID。可以为每个项目指定一个项目 ID。 ID 必须可用，并且包含 32 个字母数字值，范围包含字母 a 到 f 和数字 0 到 9。如果未提供 ID，将自动创建一个项目 ID。可以为以下项目指定项目 ID： `web_feature_layer_id`—ArcGIS Enterprise 10.8.1 或更高版本 `web_tile_layer_id`—ArcGIS Enterprise 10.8.1 或更高版本 `map_image_layer_id`—ArcGIS Enterprise 11.2 或更高版本 `ogc_feature_layer_id`—ArcGIS Enterprise 11.2 或更高版本 `wms_id`—ArcGIS Enterprise 11.2 或更高版本 `wfs_id`—ArcGIS Enterprise 11.2 或更高版本 `knowledge_graph_id`—ArcGIS Enterprise 12.0 或更高版本如果服务定义设置为覆盖现有服务，或者提供了 ArcGIS Server 连接或 ArcGIS Server URL，则此参数不可用。值表列： `Item Type`—The item type. `Item ID`—The item IDs of the output web layers staged in the input service definition.	Value Table

派生输出

名称	说明	数据类型
out_soap_svc_url	发布到服务器的服务的 SOAP URL。	String
out_rest_svc_url	发布到服务器的服务的 REST URL。	String
out_mapServiceItemID	共享到门户的地图影像图层的项目 ID。	String
out_featServiceItemID	共享到门户的托管要素服务图层的项目 ID。	String
out_cached_service	启用缓存的影像服务或地图服务。	Image Service; Map Server
out_featureServiceURL	共享到门户的托管要素图层的 REST URL。	String
out_mapServiceURL	共享到门户的地图影像图层的 REST URL。	String
out_LayerIDMap	已发布图层及其各自的 ID 采用 Layer1\|ID1;Layer2\|ID2; 的格式，以此类推。	String
out_standaloneTableIDMap	已发布独立表及其各自的 ID 采用 Table1\|ID1;Table2\|ID2; 的格式，以此类推。	String
out_vectorTileServiceID	矢量切片服务的项目 ID。	String
out_vectorTileServiceURL	矢量切片服务的 REST URL。	String
out_item_id	web 项目的项目 ID 共享至门户。项目 ID 将包含以下字符串之一： `web_feature_layer_id` `web_tile_layer_id` `map_image_layer_id` `ogc_feature_layer_id` `wms_id` `wfs_id` `knowledge_graph_id`	Value Table

代码示例

UploadServiceDefinition 示例 1（独立脚本）

以下脚本将地图中的图层列表作为 Web 切片图层发布至 ArcGIS Enterprise 或 ArcGIS Online。门户信息可从 SignInToPortal 函数中获得。

import arcpy
import os

# Sign in to portal
arcpy.SignInToPortal("https://www.arcgis.com", "MyUserName", "MyPassword")

# Set output file names
outdir = r"C:\Project\Output"
service = "TileSharingDraftExample"
sddraft_filename = service + ".sddraft"
sddraft_output_filename = os.path.join(outdir, sddraft_filename)

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps("World")[0]
lyrs = []
lyrs.append(m.listLayers('Cities')[0])
lyrs.append(m.listLayers('Counties')[0])

# Create TileSharingDraft and set service properties
sharing_draft = m.getWebLayerSharingDraft("HOSTING_SERVER", "TILE", service, lyrs)
sharing_draft.summary = "My Summary"
sharing_draft.tags = "My Tags"
sharing_draft.description = "My Description"
sharing_draft.credits = "My Credits"
sharing_draft.useLimitations = "My Use Limitations"

# Create Service Definition Draft file
sharing_draft.exportToSDDraft(sddraft_output_filename)

# Stage Service
sd_filename = service + ".sd"
sd_output_filename = os.path.join(outdir, sd_filename)
arcpy.server.StageService(sddraft_output_filename, sd_output_filename)

# Share to portal
print("Start Uploading")
result = arcpy.server.UploadServiceDefinition(sd_output_filename, "My Hosted Services")

value_table_op = arcpy.ValueTable(2)
value_table_op.loadFromString(result[11])
for i in range(0, value_table_op.rowCount):
   print(value_table_op.getRow(i))

print("Finish Publishing")

UploadServiceDefinition 示例 2（独立脚本）

以下脚本可上传现有的服务定义并可使用可选参数对该服务的属性进行修改。

import arcpy

# Set local variables
inSdFile = r"C:\Project\MapServiceDraftExample.sd"
inServer = r"C:\Project\gisserver.ags.esri.com.ags"
inServiceName = "newServiceName"
inFolderType = "NEW"
inFolder = "newFolder"
inStartup = "STOPPED"

# Run UploadServiceDefinition
arcpy.server.UploadServiceDefinition(inSdFile, inServer, inServiceName,
                                     in_folder_type=inFolderType, in_folder=inFolder,
                                     in_startupType=inStartup)

UploadServiceDefinition 示例 3（独立脚本）

以下脚本可将现有的服务定义上传到 ArcGIS Online 或 ArcGIS Enterprise 并可使用可选参数对该服务的属性进行修改。在共享到 ArcGIS Enterprise 时，可选 in_item_id 参数用于指定 Web 图层的项目 ID。

import arcpy

# Sign in to portal
arcpy.SignInToPortal("https://organization.example.com/webadaptorname",
                     "MyUserName", "MyPassword")

# Set local variables
inSdFile = r"C:\Project\MapImageLayer_WFS_WMSExample.sd"
inServer = "https://gisserver.example.com/webadaptor"
inServiceName = "newServiceName"
inFolderType = "EXISTING"
inFolder = "existingFolder"
inOverride = "OVERRIDE_DEFINITION"
inMyContents = "SHARE_ONLINE"
inPublic = "PRIVATE"
inOrganization = "NO_SHARE_ORGANIZATION"
inGroups = ["My Group", "MyGroup 2"]

# Replace "itemid1" and "itemid2" with desired item IDs
item_id = "wfs_id itemid1; wms_id itemid2"

# Run UploadServiceDefinition
arcpy.server.UploadServiceDefinition(inSdFile, inServer, inServiceName,
                                     in_folder_type=inFolderType,
                                     in_folder=inFolder,
                                     in_override=inOverride,
                                     in_my_contents=inMyContents,
                                     in_public=inPublic,
                                     in_organization=inOrganization,
                                     in_groups=inGroups,
                                     in_item_id=item_id)

环境

此工具不使用任何地理处理环境。

许可信息

基本: 是
标准: 是
高级: 是

上传服务定义 (服务器工具)

汇总

用法

参数

旧版本：

派生输出

环境

许可信息

相关主题