Queries existing and custom business scenarios.

Description

Operation: DescribeUserBizTypes

You can call this operation to query business scenarios. For more information about how to construct an HTTP request, see Request structure. You can also select an existing HTTP request. For more information, see SDK overview.

Billing: This operation is free of charge.

QPS limit

You can send up to 10 requests per second to call this operation by using your Alibaba Cloud account. If you send an excessive number of requests, throttling is implemented, and your business may be affected.

Request parameters

None.

Response parameters

Parameter Type Example Description
BizTypeList JSONArray The list of all business scenarios. Each element in the JSON array is a structure. For more information about the structure, see Table 1.
BizTypeListImport JSONArray The list of business scenarios whose configurations can be imported. Each element in the JSON array is a structure. For more information about the structure, see Table 1.
Message String OK The message that is returned for the request.
RequestId String ADDBDECA-E1B2-4988-AE3B-956BF51573EC The ID of the request.
Table 1. BizType
Parameter Type Example Description
SourceBizType String default The original business scenario. Leave this parameter empty unless you have special requirements.
BizType String mohongtest2 The business scenario.
CiteTemplate Boolean false Indicates whether the configuration of an industry template was imported. Valid values:
  • true: The configuration of an industry template was imported.
  • false: The configuration of an industry template was imported.
IndustryInfo String Social-Registration information-Profile picture The industry information.
Source String custom Indicates how the business scenario is created. Valid values:
  • custom: a custom business scenario.
  • system: the default business scenario of Content Moderation.
Description String Test business scenario The description of the business scenario.

Examples

Sample request

http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeUserBizTypes&ServiceModule=open_api
&<Common request parameters>

Sample success response

{
    "BizTypeList":[
        {
            "CiteTemplate":false,
            "BizType":"mohongtest2",
            "Source":"custom",
            "IndustryInfo":"",
      "Description": ""
        }
    ],
    "RequestId":"ADDBDECA-E1B2-4988-AE3B-956BF51573EC",
    "BizTypeListImport":[
        {
            "CiteTemplate":false,
            "BizType":"mohongtest2",
            "Source":"custom",
            "IndustryInfo":"",
      "Description": ""
        }
    ]
}