通过

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

获取服务说明

  • 项目

获取现有 Service Fabric 服务的说明。

获取现有 Service Fabric 服务的说明。 只能获取已创建的服务的说明。

请求

方法 请求 URI
GET /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout}

参数

名称 类型 必须 位置
serviceId string 是 路径
api-version 字符串 是 查询
timeout 整数 (int64) 否 查询

serviceId

类型：字符串
必需：是

服务的标识。 此 ID 通常是不带“fabric:”URI 方案的服务全名。 从版本 6.0 开始，分层名称以“~”字符隔开。 例如，如果服务名称为“fabric:/myapp/app1/svc1”，则 6.0 及更高版本中的服务标识为“myapp~app1~svc1”，在以前的版本中为“myapp/app1/svc1”。

api-version

类型：字符串
必需：是
默认：

API 的版本。 此参数是必需的，其值必须为“6.0”。

Service Fabric REST API 版本基于引入或更改 API 的运行时版本。 Service Fabric 运行时支持 API 的多个版本。 这是 API 支持的最新版本。 如果传递的 API 版本较低，则返回的响应可能与本规范中所述的响应不同。

此外，运行时接受高于当前运行时版本支持的最新版本的任何版本。 因此，如果最新的 API 版本为 6.0，但如果运行时为 6.1，为了便于编写客户端，运行时将接受该 API 的版本 6.1。 但是，API 的行为将按照记录的 6.0 版本。

timeout

类型：整数 (int64)
必需：否
默认：
InclusiveMaximum： 4294967295
InclusiveMinimum： 1

执行操作的服务器超时，以秒为单位。 此超时指定客户端可以等待请求的操作完成的持续时间。 此参数的默认值为 60 秒。

响应

HTTP 状态代码 说明 响应架构
200 (正常) 成功的操作将返回 200 状态代码。
 ServiceDescription
所有其他状态代码 详细的错误响应。
 FabricError