文档中心

云搜索服务

实例管理

DescribeScenarios - 获取场景配置

DescribeScenarios - 获取场景配置

调用 DescribeScenarios 接口获取场景配置。

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeScenarios

要执行的操作，取值：DescribeScenarios。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

Id string 可选示例值：general

场景 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Scenarios object[] 示例值：-

场景列表。

Id string 示例值：vector

场景 ID。

Name string 示例值：向量搜索

场景名称。

Description string 示例值：xxxxxx

场景描述。

SupportedKernelMajorVersions string[]

场景支持的内核版本。

AvailableResourceSpecs object[]

此场景下各节点类型支持的规格。

ResourceSpecNames string[]

资源规格名称。

Type string 示例值：Master

资源类型。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	Unauthorized	unauthorized error	用户无权限调用接口。
200	IllegalParameter	illegal parameter	参数非法。原因可能是参数缺失或不符合接口要求。
200	InternalServerError	服务器内部异常	服务由于异常退出，无法完成接口请求操作。

最近更新时间：2026.04.01 10:05:52

这个页面对您有帮助吗？

有用

有用

无用

无用