-
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 #173 from alex-smile/update_cc_apis
update cc apis
- Loading branch information
Showing
135 changed files
with
7,877 additions
and
1,545 deletions.
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
...ce/paas/esb/components/confapis/cc/apidocs/en/add_label_for_service_instance.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,56 @@ | ||
### Functional description | ||
|
||
add label for service instance | ||
|
||
#### General Parameters | ||
|
||
{{ common_args_desc }} | ||
|
||
### Request Parameters | ||
|
||
| Field | Type | Required | Description | | ||
|----------------------|------------|--------|-----------------------| | ||
| bk_supplier_account | string |Yes | Supplier Account ID | | ||
|instance_ids|array|Yes|Service Instance ID| | ||
|labels|object|Yes|Labels to be add| | ||
|
||
#### labels field description | ||
- key field validation rule: `^[a-zA-Z]([a-z0-9A-Z\-_.]*[a-z0-9A-Z])?$` | ||
- value field validation rule: `^[a-z0-9A-Z]([a-z0-9A-Z\-_.]*[a-z0-9A-Z])?$` | ||
|
||
### Request Parameters Example | ||
|
||
```python | ||
{ | ||
"bk_biz_id": 1, | ||
"instance_ids": [59, 62], | ||
"labels": { | ||
"key1": "value1", | ||
"key2": "value2" | ||
} | ||
} | ||
``` | ||
|
||
|
||
### Return Result Example | ||
|
||
```python | ||
{ | ||
"result": true, | ||
"code": 0, | ||
"message": "success", | ||
"permission": null, | ||
"data": null | ||
} | ||
``` | ||
|
||
### 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 | | ||
| data | object | response data | |
158 changes: 158 additions & 0 deletions
158
paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_create_proc_template.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,158 @@ | ||
### Functional description | ||
|
||
batch create process templates | ||
|
||
#### General Parameters | ||
|
||
{{ common_args_desc }} | ||
|
||
### Request Parameters | ||
|
||
| Field | Type | Required | Description | | ||
|----------------------|------------|--------|-----------------------| | ||
| bk_supplier_account | string |Yes | Supplier Account ID | | ||
| bk_biz_id | int |Yes | Business ID | | ||
| service_template_id | int | No | Service Template ID | | ||
| processes | array | Yes | Process Template Info | | ||
|
||
|
||
### Request Parameters Example | ||
|
||
```python | ||
{ | ||
"bk_biz_id": 1, | ||
"service_template_id": 1, | ||
"processes": [ | ||
{ | ||
"spec": { | ||
"auto_start": { | ||
"as_default_value": true, | ||
"value": false | ||
}, | ||
"auto_time_gap": { | ||
"as_default_value": false | ||
}, | ||
"bind_ip": { | ||
"as_default_value": true, | ||
"value": "1" | ||
}, | ||
"bk_biz_id": { | ||
"as_default_value": true, | ||
"value": 2 | ||
}, | ||
"bk_func_id": { | ||
"as_default_value": true, | ||
"value": "1" | ||
}, | ||
"bk_func_name": { | ||
"as_default_value": true, | ||
"value": "nginx" | ||
}, | ||
"bk_process_id": { | ||
"as_default_value": true, | ||
"value": 3 | ||
}, | ||
"bk_process_name": { | ||
"as_default_value": true, | ||
"value": "" | ||
}, | ||
"bk_supplier_account": { | ||
"as_default_value": true, | ||
"value": "" | ||
}, | ||
"create_time": { | ||
"as_default_value": true, | ||
"value": "2019-05-06T07:12:35.082Z" | ||
}, | ||
"description": { | ||
"as_default_value": true, | ||
"value": "a simple description" | ||
}, | ||
"face_stop_cmd": { | ||
"as_default_value": true, | ||
"value": "./stop.sh" | ||
}, | ||
"last_time": { | ||
"as_default_value": true, | ||
"value": "2019-05-06T07:12:35.082Z" | ||
}, | ||
"pid_file": { | ||
"as_default_value": true, | ||
"value": "" | ||
}, | ||
"port": { | ||
"as_default_value": true, | ||
"value": "8000,8001,8003,8004" | ||
}, | ||
"priority": { | ||
"as_default_value": true, | ||
"value": 1 | ||
}, | ||
"proc_num": { | ||
"as_default_value": true, | ||
"value": 1 | ||
}, | ||
"protocol": { | ||
"as_default_value": true, | ||
"value": "1" | ||
}, | ||
"reload_cmd": { | ||
"as_default_value": true, | ||
"value": "" | ||
}, | ||
"restart_cmd": { | ||
"as_default_value": true, | ||
"value": "./restart.sh" | ||
}, | ||
"start_cmd": { | ||
"as_default_value": true, | ||
"value": "./start.sh" | ||
}, | ||
"stop_cmd": { | ||
"as_default_value": true, | ||
"value": "./stop.sh" | ||
}, | ||
"timeout": { | ||
"as_default_value": true, | ||
"value": 60 | ||
}, | ||
"user": { | ||
"as_default_value": true, | ||
"value": "" | ||
}, | ||
"work_path": { | ||
"as_default_value": true, | ||
"value": "/data/bkee" | ||
}, | ||
"bk_start_param_regex": { | ||
"as_default_value": true, | ||
"value": "" | ||
} | ||
} | ||
} | ||
] | ||
} | ||
``` | ||
|
||
### Return Result Example | ||
|
||
```python | ||
{ | ||
"result": true, | ||
"code": 0, | ||
"message": "success", | ||
"permission": null, | ||
"data": [[52]] | ||
} | ||
``` | ||
|
||
### 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 | | ||
| data | object | response data | |
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
paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_update_host.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 | ||
|
||
update host properties in batches(can't update host's cloud area property) | ||
|
||
### Request Parameters | ||
|
||
{{ common_args_desc }} | ||
|
||
#### General Parameters | ||
|
||
| Field | Type | Required | Description | | ||
|---------------------|--------------|----------|----------------------------------------------------------------| | ||
| bk_supplier_account | string | No | Supplier account | | ||
| update | object array | Yes | The updated properties and values for the host, limited to 500 | | ||
|
||
#### update | ||
| Field | Type | Required | Description | | ||
|------------|--------|----------|------------------------------------------------------------------------------| | ||
| properties | object | Yes | The updated properties for the host, can't update host's cloud area property | | ||
| bk_host_id | int | Yes | The host ID, for host update | | ||
|
||
#### properties | ||
| Field | Type | Required | Description | | ||
|--------------|--------|----------|---------------------------------------------------------------------------------| | ||
| bk_host_name | string | No | Host name, or other properties, can't update host's cloud area property | | ||
| operator | string | No | Maintainer, or other properties, can't update host's cloud area property | | ||
| bk_comment | string | No | Comment, or other properties, can't update host's cloud area property | | ||
| bk_isp_name | string | No | Telecom operators, or other properties, can't update host's cloud area property | | ||
|
||
|
||
### Request Parameters Example | ||
|
||
```json | ||
{ | ||
"bk_supplier_account":"0", | ||
"update":[ | ||
{ | ||
"properties":{ | ||
"bk_host_name":"batch_update", | ||
"operator": "admin", | ||
"bk_comment": "test", | ||
"bk_isp_name": "1" | ||
}, | ||
"bk_host_id":46 | ||
} | ||
] | ||
} | ||
``` | ||
|
||
|
||
### Return Result Example | ||
|
||
```json | ||
{ | ||
"result": true, | ||
"code": 0, | ||
"message": "success", | ||
"data": null | ||
} | ||
``` |
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
51 changes: 0 additions & 51 deletions
51
paas-ce/paas/esb/components/confapis/cc/apidocs/en/bind_role_privilege.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.