Merge pull request #173 from alex-smile/update_cc_apis

update cc apis
TencentBlueKing · Feb 21, 2020 · 98af7a3 · 98af7a3
2 parents 6c8af4f + 6ad227d
commit 98af7a3
Show file tree

Hide file tree

Showing 135 changed files with 7,877 additions and 1,545 deletions.
diff --git a/...ce/paas/esb/components/confapis/cc/apidocs/en/add_label_for_service_instance.md b/...ce/paas/esb/components/confapis/cc/apidocs/en/add_label_for_service_instance.md
@@ -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 |
diff --git a/paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_create_proc_template.md b/paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_create_proc_template.md
@@ -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 |
diff --git a/paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_delete_inst.md b/paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_delete_inst.md
@@ -11,7 +11,7 @@ delete object instances in batches
 | Field                |  Type       | Required	   | Description                            |
 |---------------------|-------------|--------|----------------------------------|
 | bk_supplier_account | string      | Yes     | Supplier account                       |
-| bk_obj_id           | string      | Yes     | Object ID, when the deleted object is a cloud, it is a plat |
+| bk_obj_id           | string      | Yes     | Object ID |
 | inst_ids            | int array   |Yes      | Instance ID group                       |
 
 

diff --git a/paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_update_host.md b/paas-ce/paas/esb/components/confapis/cc/apidocs/en/batch_update_host.md
@@ -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
+}
+```
diff --git a/paas-ce/paas/esb/components/confapis/cc/apidocs/en/bind_process_module.md b/paas-ce/paas/esb/components/confapis/cc/apidocs/en/bind_process_module.md
@@ -19,7 +19,12 @@ bind process to module
 ### Request Parameters Example
 
 ```python
-
+{
+    "bk_supplier_account":"0",
+    "bk_biz_id":3,
+    "bk_process_id":14,
+    "bk_module_name":"db"
+}
 ```
 
 

diff --git a/paas-ce/paas/esb/components/confapis/cc/apidocs/en/bind_role_privilege.md b/paas-ce/paas/esb/components/confapis/cc/apidocs/en/bind_role_privilege.md