接口请求域名： tat.intl.tencentcloudapi.com 。
此接口用于查询场景详情。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeScenes。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SceneIds.N | 否 | Array of String | 场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 SceneIds 和 Filters 。 |
| Filters.N | 否 | Array of Filter | 过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 Filters 的上限为10， Filter.Values 的上限为5。参数不支持同时指定 SceneIds 和 Filters 。 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。关于 Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
| Offset | 否 | Integer | 偏移量，默认为0。关于 Offset 的更进一步介绍请参考 API 简介中的相关小节。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的场景总数。 |
| SceneSet | Array of Scene | 场景详情列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScenes
<公共请求参数>
{
"SceneIds": [
"sc-12345678"
],
"Offset": 0,
"Limit": 20
}
{
"Response": {
"RequestId": "eb973a12-71e3-4c0c-b1d8-4b863e5f5daf",
"TotalCount": 1,
"SceneSet": [
{
"SceneId": "sc-12345678",
"SceneName": "运维场景",
"CreatedBy": "TAT",
"CreatedTime": "2020-11-02T02:48:11+00:00",
"UpdatedTime": "2020-11-02T02:48:11+00:00"
}
]
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ConflictParameter | 参数冲突。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidFilter | Filter 无效。 |
| InvalidParameterValue.InvalidSceneId | 无效的场景 ID。 |
| InvalidParameterValue.InvalidSceneName | 无效的场景名称。 |
| LimitExceeded.FilterValueExceeded | 填写的 Filter 取值过多。 |
| UnauthorizedOperation.CamAuthFailed | CAM鉴权失败。 |
| UnauthorizedOperation.MFAExpired | Multi-Factor Authentication(MFA) 过期。 |
| UnauthorizedOperation.MFANotFound | Multi-Factor Authentication(MFA) 不存在。 |
文档反馈