本文介绍了如何通过DescribeUserBizTypes接口查询已创建和自定义的业务场景列表,用于在后台管理业务场景数据。
使用说明
业务接口:DescribeUserBizTypes
您可以调用该接口查询业务场景(BizType)。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览。
计费信息:该接口为免费接口。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
请求参数
无。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BizTypeList | JSONArray | 所有业务场景列表。JSON数组中的每个元素是一个结构体,关于具体结构描述,请参见表 1。 | |
BizTypeListImport | JSONArray | 可导入的业务场景列表。JSON数组中的每个元素是一个结构体,关于具体结构描述,请参见表 1。 | |
Message | String | OK | 请求信息的响应消息。 |
RequestId | String | ADDBDECA-E1B2-4988-AE3B-956BF51573EC | 对应的请求ID。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
SourceBizType | String | default | 原始BizType,如无特殊需求请忽略该字段。 |
BizType | String | mohongtest2 | 业务场景。 |
CiteTemplate | Boolean | false | 是否引入行业模板配置。取值:
|
IndustryInfo | String | 社交-注册信息-头像 | 行业信息。 |
Source | String | custom | 业务场景来源。取值:
|
Description | String | 测试业务场景 | 业务场景描述。 |
示例
请求示例
http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeUserBizTypes&ServiceModule=open_api
&<公共请求参数>
正常返回示例
{
"BizTypeList":[
{
"CiteTemplate":false,
"BizType":"mohongtest2",
"Source":"custom",
"IndustryInfo":"",
"Description": ""
}
],
"RequestId":"ADDBDECA-E1B2-4988-AE3B-956BF51573EC",
"BizTypeListImport":[
{
"CiteTemplate":false,
"BizType":"mohongtest2",
"Source":"custom",
"IndustryInfo":"",
"Description": ""
}
]
}