DescribeUserBizTypes-AI Guardrails(AI Guardrails)-阿里云帮助中心

Retrieves the business scenarios of a user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-greenweb:DescribeUserBizTypes

get

*BizType

acs:yundun-greenweb:*:{#accountId}:biztype/*

None

Request parameters

Parameter	Type	Required	Description	Example
Customized	boolean	No	Specifies whether the business type is customized. Valid values: true: customized false: not customized.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
BizTypeList	array<object>	The list of all business scenarios.
	object
IndustryInfo	string	The industry information.	教育-论坛社区-主贴
Description	string	The description of the business scenario.	xxx
CiteTemplate	boolean	Indicates whether an industry template configuration is used. Valid values: true: An industry template configuration is used. false: No industry template configuration is used.	false
SourceBizType	string	The original BizType. Ignore this field unless you have specific requirements.	default
Gray	boolean	Indicates whether grayscale is enabled. Valid values: true: Enabled. false: Disabled.	false
Source	string	The source of the business scenario. Valid values: custom: custom information that you defined. system: default configurations of the Content Moderation service.	custom
BizType	string	The business scenario.	default
BizTypeListImport	array<object>	The list of business scenarios that can be imported.
	object
IndustryInfo	string	The industry information.	社交-注册信息-昵称
Description	string	The description of the business scenario.	xxx
CiteTemplate	boolean	Indicates whether an industry template configuration is used. Valid values: true: An industry template configuration is used. false: No industry template configuration is used.	false
SourceBizType	string	The original BizType. Ignore this field unless you have specific requirements.	default
Gray	boolean	Indicates whether grayscale is enabled. Valid values: true: Enabled. false: Disabled.	false
Source	string	The source of the business scenario. Valid values: custom: custom information that you defined. system: default configurations of the Content Moderation service.	custom
BizType	string	The business scenario.	default

Examples

Success response

JSON format

{
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "BizTypeList": [
    {
      "IndustryInfo": "教育-论坛社区-主贴",
      "Description": "xxx",
      "CiteTemplate": false,
      "SourceBizType": "default",
      "Gray": false,
      "Source": "custom",
      "BizType": "default"
    }
  ],
  "BizTypeListImport": [
    {
      "IndustryInfo": "社交-注册信息-昵称",
      "Description": "xxx",
      "CiteTemplate": false,
      "SourceBizType": "default",
      "Gray": false,
      "Source": "custom",
      "BizType": "default"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.