-
Notifications
You must be signed in to change notification settings - Fork 373
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #778 from alex-smile/ft_esb_update_apis_20220310
Ft esb update apis 20220310
- Loading branch information
Showing
44 changed files
with
1,925 additions
and
379 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
2.13.30 | ||
2.13.31 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
paas2/esb/components/confapis/cc/apidocs/en/create_business_set.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
### Functional description | ||
|
||
create business set(v3.10.12+) | ||
|
||
|
||
### Request Parameters | ||
|
||
{{ common_args_desc }} | ||
|
||
|
||
#### General Parameters | ||
|
||
| Field | Type | Required | Description | | ||
|-----------|------------|--------|---------------------------| | ||
| bk_biz_set_attr | object | Yes | business set model field| | ||
| bk_scope | object | Yes | selected business scope| | ||
|
||
#### bk_biz_set_attr | ||
|
||
| Field | Type | Required | Description | | ||
|-----------|------------|--------|------------------| | ||
| bk_biz_set_name | string | Yes | business set name| | ||
| bk_biz_maintainer | string | No | the maintainers | | ||
| bk_biz_set_desc | string | No | business description | | ||
|
||
#### bk_scope | ||
|
||
| Field | Type | Required | Description | | ||
|-----------|------------|--------|------------| | ||
| match_all | bool | Yes | selected business line tags| | ||
| filter | object | No | scope conditions for the selected business| | ||
|
||
#### filter | ||
|
||
- This parameter is a combination of business attribute field filtering rules, which is used to search for business based on business attribute fields. Combinations only support AND operations and can be nested up to 2 levels. | ||
|
||
| Field | Type | Required | Description | | ||
|-----------|------------|--------|------------| | ||
| condition | string | Yes | rule operator| | ||
| rules | array | Yes | scope condition rules for the selected business| | ||
|
||
|
||
#### rules | ||
|
||
| Field | Type | Required | Description | | ||
| -------- | ------ | ---- | ---------------------------------- | | ||
| field | string | No | field name | | ||
| operator | string | No | available values: equal,in | | ||
| value | - | No | values's format depend on operator | | ||
|
||
**Note:** | ||
|
||
- The input here only describes the required and built-in parameters for the `bk_biz_set_attr` parameter, and the other parameters that need to be filled depend on the attribute fields defined by the user. | ||
- when the `match_all` field in `bk_scope` is true, it means that the selected business scope of the business set is all, and the parameter `filter` is empty. If the `match_all` field is false, | ||
`filter` needs to be non-null and the user needs to explicitly specify choice of business | ||
- The selected business type must be enum or organization. | ||
|
||
### Request Parameters Example | ||
|
||
```python | ||
{ | ||
"bk_app_code":"esb_test", | ||
"bk_app_secret":"xxx", | ||
"bk_username":"xxx", | ||
"bk_token":"xxx", | ||
"bk_biz_set_attr":{ | ||
"bk_biz_set_name":"biz_set", | ||
"bk_biz_set_desc":"xxx", | ||
"biz_set_maintainer":"xxx" | ||
}, | ||
"bk_scope":{ | ||
"match_all":false, | ||
"filter":{ | ||
"condition":"AND", | ||
"rules":[ | ||
{ | ||
"field":"bk_sla", | ||
"operator":"equal", | ||
"value":"2" | ||
}, | ||
{ | ||
"field":"life_cycle", | ||
"operator":"equal", | ||
"value":1 | ||
} | ||
] | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### Return Result Example | ||
|
||
```python | ||
|
||
{ | ||
"result":true, | ||
"code":0, | ||
"message":"success", | ||
"permission":null, | ||
"data":5, | ||
"request_id": "dsda1122adasadadada2222" | ||
} | ||
``` | ||
### Return Result Parameters Description | ||
|
||
#### response | ||
|
||
| Field | Type | Description | | ||
| ------- | ------ | ------------------------------------- | | ||
| result | bool | request success or failed. true:success;false: failed | | ||
| code | int | error code. 0: success, >0: something error | | ||
| message | string | error info description | | ||
| permission | object | permission info | | ||
| data | int | business set id | | ||
| request_id | string | request chain id | |
52 changes: 52 additions & 0 deletions
52
paas2/esb/components/confapis/cc/apidocs/en/delete_business_set.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
### Functional description | ||
|
||
delete business set(v3.10.12+) | ||
|
||
### Request Parameters | ||
|
||
{{ common_args_desc }} | ||
|
||
#### General Parameters | ||
|
||
| Field | Type | Required | Description | | ||
|-----------|------------|--------|------------| | ||
| bk_biz_set_ids | array | Yes |business set id list | | ||
|
||
### Request Parameters Example | ||
|
||
```python | ||
{ | ||
"bk_app_code":"esb_test", | ||
"bk_app_secret":"xxx", | ||
"bk_username":"xxx", | ||
"bk_token":"xxx", | ||
"bk_biz_set_ids":[ | ||
10, | ||
12 | ||
] | ||
} | ||
``` | ||
|
||
### Return Result Example | ||
|
||
```python | ||
{ | ||
"result": true, | ||
"code": 0, | ||
"message": "", | ||
"permission":null, | ||
"data": {}, | ||
"request_id": "dsda1122adasadadada2222" | ||
} | ||
``` | ||
### Return Result Parameters Description | ||
#### response | ||
|
||
| Field | Type | Description | | ||
| ------- | ------ | ------------------------------------- | | ||
| result | bool | request success or failed. true:success;false: failed | | ||
| code | int | error code. 0: success, >0: something error | | ||
| message | string | error info description | | ||
| permission | object | permission info | | ||
| data | object | response data | | ||
| request_id | string | request chain id | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.