# 订阅和取消AI助手 - SubscribeAiAssistant
#### 功能介绍
订阅用户可以使用ai提供的能力。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=SubscribeAiAssistant)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                  | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:users:subscribeAiAssistant | Write | -           | -   | -  | -      |
     
  
 
#### URI
POST /v3/users/ai-assistant/subscribe
#### 请求参数
表1请求Body参数 
| 参数     | 是否必选 | 参数类型                                                                                 | 描述                         |
|:---|:---|:---|:---|
| add    | 否    | [SubscribeOperationReq] object | 添加订阅的请求，必须包含项目、用户或用户组中的一项。 |
| delete | 否    | [SubscribeOperationReq] object | 删除订阅的请求，必须包含项目、用户或用户组中的一项。 |
   
 表2SubscribeOperationReq 
| 参数         | 是否必选 | 参数类型                                                                                                         | 描述      |
|:---|:---|:---|:---|
| project    | 否    | [project] object                                                     | 项目信息    |
| users      | 否    | Array of [CreateSubscribeUserInfo] objects           | 用户信息列表  |
| usergroups | 否    | Array of [CreateSubscribeUserGroupInfo] objects | 用户组信息列表 |
   
 表3project 
| 参数         | 是否必选 | 参数类型   | 描述   |
|:---|:---|:---|:---|
| project_id | 否    | String | 项目ID |
   
 表4CreateSubscribeUserInfo 
| 参数      | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| user_id | 否    | String | 用户id。 |
   
 表5CreateSubscribeUserGroupInfo 
| 参数       | 是否必选 | 参数类型   | 描述     |
|:---|:---|:---|:---|
| group_id | 是    | String | 用户组ID。 |
   
#### 响应参数
**状态码：200**
订阅用户响应。
**状态码：400**
表6响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：401**
表7响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：403**
表8响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：404**
表9响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：405**
表10响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：500**
表11响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：503**
表12响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码。                                                         |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
#### 请求示例
```
POST /v3/users/ai-assistant/subscribe
{
  "add" : {
    "project" : {
      "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
    },
    "users" : [ {
      "user_id" : "1c873056-9f4d-11ec-b909-0242ac120002"
    } ],
    "usergroups" : [ {
      "group_id" : "8885bcc45da1f762015da20130a1000"
    } ]
  },
  "delete" : {
    "project" : {
      "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
    },
    "users" : [ {
      "user_id" : "1c873056-9f4d-11ec-b909-0242ac120002"
    } ],
    "usergroups" : [ {
      "group_id" : "8885bcc45da1f762015da20130a1000"
    } ]
  }
}
```
#### 响应示例
**状态码：200**
订阅用户响应。
```
null
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 订阅用户响应。                 |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。