-
Notifications
You must be signed in to change notification settings - Fork 374
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 #1023 from alex-smile/esb_update_apis_20220809
update: esb update monitor_v3, bk_log, itsm, gsekit confapis
- Loading branch information
Showing
18 changed files
with
587 additions
and
152 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.12.54 | ||
2.12.55 |
95 changes: 0 additions & 95 deletions
95
paas2/esb/components/bk/apis/bk_login/get_batch_user_platform_role.py
This file was deleted.
Oops, something went wrong.
40 changes: 0 additions & 40 deletions
40
paas2/esb/components/bk/apisv2/bk_login/get_batch_users_platform_role.py
This file was deleted.
Oops, something went wrong.
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
62 changes: 62 additions & 0 deletions
62
paas2/esb/components/confapis/gsekit/apidocs/zh_hans/access_overview.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,62 @@ | ||
### 请求地址 | ||
|
||
/v2/gsekit/api/meta/access_overview/ | ||
|
||
### 请求方式 | ||
|
||
GET | ||
|
||
### 功能描述 | ||
|
||
业务接入情况概览 | ||
|
||
### 请求参数 | ||
|
||
{{ common_args_desc }} | ||
|
||
#### 接口参数 | ||
|
||
| 字段 | 类型 | 必选 | 描述 | | ||
| --------- | ---- | ---- | ------ | | ||
| bk_biz_id | int | 是 | 业务ID | | ||
|
||
### 请求参数示例 | ||
|
||
``` json | ||
{ | ||
"bk_biz_id": 2 | ||
} | ||
``` | ||
|
||
### 返回结果示例 | ||
|
||
```json | ||
{ | ||
"result": true, | ||
"data": { | ||
"is_access": true, | ||
"process": true, | ||
"configfile": true | ||
}, | ||
"code": 0, | ||
"message": "" | ||
} | ||
``` | ||
|
||
### 返回结果参数说明 | ||
|
||
| 字段 | 类型 | 描述 | | ||
| ------- | ------ | --------------------------------- | | ||
| result | bool | 返回结果,true为成功,false为失败 | | ||
| code | int | 返回码,0表示成功,其他值表示失败 | | ||
| message | string | 返回信息 | | ||
| data | dict | 详细结果,详见data定义 | | ||
|
||
|
||
#### data | ||
|
||
| 字段 | 类型 | 描述 | | ||
|------------|------|------------------------------------| | ||
| is_access | bool | 是否已接入本系统,以下模块其中一个为 `true` 视为已接入本系统 | | ||
| process | bool | 是否已接入进程相关功能 | | ||
| configfile | bool | 是否已接入配置相关功能 | |
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
60 changes: 60 additions & 0 deletions
60
paas2/esb/components/confapis/itsm/apidocs/en/create_service_catalog.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,60 @@ | ||
### Functional description | ||
|
||
ticket comment interface | ||
|
||
### Request Parameters | ||
|
||
{{ common_args_desc }} | ||
|
||
#### Interface Parameters | ||
|
||
| Field | Type | Required | Description | | ||
| --------- | ------ | --- | -------------------------- | | ||
| parent__id | int | YES | The parent catalog id | | ||
| name | string | YES | catalog name | | ||
| desc | string | NO | catalog desc | | ||
| project_key | string | YES | project_id, default "0" | | ||
|
||
|
||
### Request Parameters Example | ||
|
||
```json | ||
{ | ||
"parent__id": 2, | ||
"name": "test", | ||
"desc": "123", | ||
"project_key": "0" | ||
} | ||
``` | ||
|
||
### Return Result Example | ||
|
||
```json | ||
{ | ||
"result": true, | ||
"code": 0, | ||
"message": "success", | ||
"data": { | ||
"id": 38, | ||
"key": "4018b68b7987b5b0fdafcde492715ea1", | ||
"level": 2, | ||
"parent": 2, | ||
"parent_name": "root>xxxx", | ||
"parent_key": "FUWUFANKUI", | ||
"parent__id": "2", | ||
"parent__name": "xxxx", | ||
"name": "test", | ||
"desc": "", | ||
"project_key": "0" | ||
} | ||
} | ||
``` | ||
|
||
### Return Result Description | ||
|
||
| Field | Type | Description | | ||
| ------- | --------- | ----------------------- | | ||
| result | bool | true/false, indicate success or failure | | ||
| code | int | return code. 0 indicates success, other values indicate failure | | ||
| message | string | error message returned when result is false | | ||
| data | object | return data | |
78 changes: 78 additions & 0 deletions
78
paas2/esb/components/confapis/itsm/apidocs/en/import_service.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,78 @@ | ||
### Functional description | ||
|
||
Import the service. Obtain the metadata from the service list and export the service. | ||
|
||
### Request Parameters | ||
|
||
{{ common_args_desc }} | ||
|
||
#### Interface Parameters | ||
|
||
| Field | Type | Required | Description | | ||
|-----------|------------|--------|------------| | ||
| key | string | YES | Service type | | ||
| name | string | YES | service_name | | ||
| catalog_id | int | YES | catalog id | | ||
| desc | string | NO | service desc| | ||
| owners | string | NO | service owners | | ||
| can_ticket_agency | bool | YES | Could you replace the BILL of lading | | ||
| is_valid | bool | YES | Whether to enable or disable the default value is false | | ||
| display_type | string | YES | display type | | ||
| display_role | string | YES | display role,Display_type is open and the value is null| | ||
| source | string | YES | source| | ||
| project_key | string | YES | project key| | ||
| workflow | json | YES | workflow data| | ||
|
||
|
||
|
||
### Request Parameters Example | ||
|
||
``` json | ||
{ | ||
"key": "request", | ||
"name": "测试服务", | ||
"catalog_id":38, | ||
"desc": "", | ||
"owners": "admin", | ||
"can_ticket_agency": false, | ||
"is_valid": true, | ||
"display_type": "OPEN", | ||
"display_role": "", | ||
"source": "custom", | ||
"project_key": "0", | ||
"workflow":{} | ||
} | ||
``` | ||
### Return Result Example | ||
|
||
```json | ||
{ | ||
"result": true, | ||
"code": 0, | ||
"message": "success", | ||
"data": { | ||
"id": 94, | ||
"name": "测试服务", | ||
"service_type": "request", | ||
"desc": "" | ||
} | ||
} | ||
``` | ||
|
||
### Return Result Description | ||
|
||
| 字段 | 类型 | 描述 | | ||
|-----------|-----------|-----------| | ||
|result| bool | 返回结果,true为成功,false为失败 | | ||
|code|int|返回码,0表示成功,其他值表示失败| | ||
|message|string|错误信息 | ||
|data| object| 返回数据 | | ||
|
||
### data | ||
|
||
| 字段 | 类型 | 描述 | | ||
|-----------|-----------|-----------| | ||
|id| int | 服务id | | ||
|name|string|服务名| | ||
|service_type|string|服务类型| | ||
|desc| string| 服务描述 | |
Oops, something went wrong.