您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

获取服务说明

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

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

请求

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

parameters

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

serviceId

类型: 字符串
必需: 是

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


api-version

类型: 字符串
必需: 是
默认值6.0

API 的版本。 此参数是必需的,其值必须为"6.0"。

服务结构 REST API 版本基于引入或更改 API 的运行时版本。 服务结构运行时支持多个版本的 API。 这是 API 支持的最新版本。 如果传递了较低的 API 版本,则返回的响应可能与本规范中记录的响应不同。

此外,运行时接受任何版本高于当前受支持的版本,以连接到运行时的当前版本。 因此,如果最新的 API 版本为 6.0,但如果运行时为 6.1,为了更轻松地编写客户端,运行时将接受该 API 的版本 6.1。 但是,API 的行为将按文档记录的 6.0 版本进行。


timeout

类型: 整数 (int64)
必需: 否
默认值60
包含最大值4294967295
包含最小 :1

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

响应

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