Search - 内容搜索

该接口主要用于客户侧搜索内容管理平台中的图文、视频等内容。如果开启了内容权限，那么将根据场景所属用户组所关联的权限标识对内容进行过滤，保留关联权限标识内容。

注意事项

• 前提条件：
  • 请联系火山侧产品人员，开通C端搜索功能，搜索接口权限配置流程繁琐，1-2天，若需使用，请提前联系火山人员进行相关配置。
  • 已完成非内容集合场景的创建，详见：2.3 创建非内容场景。

请求说明

• 请求方式：POST
• 请求地址：https://cms.volcengineapi.com?Action=Search&Version=2022-01-01
• 请求头：ServiceName: volc_content_api

请求参数

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

Query

Body

返回参数

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

请求示例 1

{
    "UniqUserId": "123",
    "Category": "123",
    "Keyword": "示例",
    "Offset": 0,
    "PageSize": 1
}

返回示例 1

{
	"ResponseMetadata": {
		"RequestId": "20220120205147010225110011040A1***",
		"Action": "Search",
		"Version": "2022-01-01",
		"Service": "volc_content_api",
		"Region": "cn-north-1"
	},
	"Data": {
		"ArticleList": [{
			"Article": {
				"GroupId": 1719832382917719,
				"Title": "示例title",
				"Author": {
					"AuthorName": "示例作者名",
					"AuthorAvatarUrl": ".....",
					"AuthorId": "1711943343958046",
					"Description": "...",
					"HomePage": "",
					"FollowerCount": 1000,
					"AuthorBizId": ""
				},
				"GroupType": "article",
				"GenerateType": "test_source",
				"PublishTime": 1640159969,
				"Abstract": "",
				"OpenId": "",
				"Tags": [
					"示例tag1",
					"示例tag2"
				],
				"CoverImages": [{
					"Url": ".....",
					"Height": 750,
					"Weight": 1201,
					"Width": 1201
				}],
				"Extra": "",
				"Link": "",
				"DiggCount": 0,
				"CommentCount": 0,
				"CommentUrl": ""
			},
			"DisplayTitle": "<em>示例</em>title",
			"DisplaySummary": ""
		}, ...],
		"Total": 1,
		"HasMore": false,
		"Offset": 0,
		"Keyword": "示例",
		"FixQuery": "示例"
	},
	"BaseResp": {
		"StatusMessage": "success",
		"StatusCode": 1000
	}
}

请求示例 2

{
    "UniqUserId": "123",
    "Category": "123",
    "Keyword": "示例",
    "Offset": 0,
    "PageSize": 1
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "2022090816261001020801815226363***",
        "Action": "Search",
        "Version": "2022-01-01",
        "Service": "volc_content_api",
        "Region": "cn-north-1"
    },
    "Data": {
        "ArticleList": null,
        "Total": 0,
        "HasMore": false,
        "Offset": 0,
        "Keyword": "xxx",
        "FixQuery": ""
    },
    "BaseResp": {
        "StatusMessage": "success",
        "StatusCode": 1000
    }
}

错误码

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