DescribeCloudNotePhrases - 热词表列表

纪要热词列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:DescribeCloudNotePhrasesget
*App
acs:rtc::{#accountId}:app/{#AppId}

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。通过控制台创建和查询,仅支持传单个 ID。

ac7N****
PageNuminteger

第几页,默认查询第 1 页。

1
PageSizeinteger

每页显示个数,默认为 10。

10
Conditionobject

查询条件。

Idstring

热词表 ID。

ac7N****112121
Namestring

热词表名称。

测试

返回参数

名称类型描述示例值
object

Schema of Response。

RequestIdstring

Id of the request。

3A26E1E3-3CBB-599E-AD68-CB78F5A42FA1
TotalNumlong

记录数。

10
TotalPagelong

分页数。

1
Phrasesarray<object>

热词列表。

Phraseobject

热词配置。

Descriptionstring

描述。

水果描述
CreateTimestring

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2025-03-04T06:22:15Z
Idstring

热词表 ID。

1qweadca332121212
WordWeightsarray<object>

热词权重。

WordWeightobject

热词权重。

Wordstring

热词。

苹果
Weightinteger

权重取值。

0
Namestring

热词表名称。

水果

示例

正常返回示例

JSON格式

{
  "RequestId": "3A26E1E3-3CBB-599E-AD68-CB78F5A42FA1",
  "TotalNum": 10,
  "TotalPage": 1,
  "Phrases": [
    {
      "Description": "水果描述",
      "CreateTime": "2025-03-04T06:22:15Z",
      "Id": "1qweadca332121212",
      "WordWeights": [
        {
          "Word": "苹果",
          "Weight": 0
        }
      ],
      "Name": "水果"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ParameterError%s.参数错误
400Function.Disable%s.功能状态不合法,请在功能启用的状态下请求。
400Quota.Invalid%s.资源配额不足,请提交工单加大配额
404NotFound%s.请求的资源不存在

访问错误中心查看更多错误码。