Skip to content

Commit

Permalink
feat: 增加查询文件源与凭证详情的ApiGW接口 TencentBlueKing#2830
Browse files Browse the repository at this point in the history
  • Loading branch information
@liuliaozhong
liuliaozhong committed Apr 8, 2024
1 parent 02ebd30 commit ff632d5
Show file tree
Hide file tree
Showing 43 changed files with 109 additions and 459 deletions.
12 changes: 6 additions & 6 deletions docs/apidoc/bk-api-gateway/v3/zh/get_credential_detail.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@
| bk_scope_type | string | 是 | 资源范围类型。可选值: biz - 业务，biz_set - 业务集 |
| bk_scope_id | string | 是 | 资源范围ID, 与bk_scope_type对应, 表示业务ID或者业务集ID |
| bk_biz_id | long | 是 | *已弃用*。业务ID。此字段已被弃用并由字段bk_scope_type+bk_scope_id替换 |
| id | String | 是 | 凭据ID |
| id | String | 是 | 凭证ID |

### 请求参数示例

- GET
```json
/api/v3/get_credential_detail?bk_scope_type=biz&bk_scope_id=1&id=xxx
/api/v3/get_credential_detail?bk_scope_type=biz&bk_scope_id=2&id=xxx
```

### 返回结果示例
Expand All @@ -47,7 +47,7 @@
"creator": "admin",
"create_time": 1712049204719,
"last_modify_user": "admin",
"last_modify_time": "1712049204719"
"last_modify_time": 1712049204719
}
}
```
Expand All @@ -67,11 +67,11 @@
| ---------------- | ------ | ------------------------------------------------------------ |
| bk_scope_type | string | 资源范围类型。可选值: biz - 业务，biz_set - 业务集 |
| bk_scope_id | string | 资源范围ID, 与bk_scope_type对应, 表示业务ID或者业务集ID |
| id | string | 凭据ID |
| id | string | 凭证ID |
| name | string | 凭证名称 |
| type | string | 类型。可选值：APP_ID_SECRET_KEY，PASSWORD，USERNAME_PASSWORD，SECRET_KEY|
| description | string | 描述 |
| creator | string | 作业创建人账号 |
| create_time | long | 创建时间，Unix 时间戳 |
| create_time | long | 创建时间，Unix时间戳（ms） |
| last_modify_user | string | 作业修改人账号 |
| last_modify_time | long | 最后修改时间，Unix 时间戳 |
| last_modify_time | long | 最后修改时间，Unix时间戳（ms） |
16 changes: 8 additions & 8 deletions docs/apidoc/bk-api-gateway/v3/zh/get_file_source_detail.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

- GET
```json
/api/v3/get_file_source_detail?bk_scope_type=biz&bk_scope_id=1&code=1
/api/v3/get_file_source_detail?bk_scope_type=biz&bk_scope_id=2&code=bkrepo-1
```

### 返回结果示例
Expand All @@ -40,11 +40,11 @@
"data": {
"bk_scope_type": "biz",
"bk_scope_id": "2",
"id": 0,
"code": "xxx",
"id": 10001,
"code": "bkrepo-1",
"alias": "xxx",
"status": 0,
"file_source_type": 3,
"file_source_type_code": "BLUEKING_ARTIFACTORY",
"is_public": false,
"credential_id": "xxx",
"enable": true,
Expand Down Expand Up @@ -75,11 +75,11 @@
| code | string | 文件源code |
| alias | string | 文件源别名 |
| status | int | 状态 |
| file_source_type | int | 类型。可选值：蓝鲸制品库 |
| file_source_type_code | string | 文件源类型code。可选值：BLUEKING_ARTIFACTORY |
| is_public | bool | 是否为公用文件源 |
| credential_id | string | 凭据ID |
| credential_id | string | 凭证ID |
| enable | bool | 是否启用 |
| creator | string | 作业创建人账号 |
| create_time | long | 创建时间，Unix 时间戳 |
| create_time | long | 创建时间，Unix时间戳（ms） |
| last_modify_user | string | 作业修改人账号 |
| last_modify_time | long | 最后修改时间，Unix 时间戳 |
| last_modify_time | long | 最后修改时间，Unix时间戳（ms） |
79 changes: 0 additions & 79 deletions docs/apidoc/esb/jobv3-confapis/apidocs/en/get_credential_detail.md
View file

This file was deleted.

87 changes: 0 additions & 87 deletions docs/apidoc/esb/jobv3-confapis/apidocs/en/get_file_source_detail.md
View file

This file was deleted.

18 changes: 9 additions & 9 deletions docs/apidoc/esb/jobv3-confapis/apidocs/zh_hans/create_credential.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### 功能描述

新建凭据。
新建凭证。

### 请求参数

Expand All @@ -12,13 +12,13 @@
|----------------------------|------------|--------|------------|
| bk_scope_type | string | 是 | 资源范围类型。可选值: biz - 业务，biz_set - 业务集 |
| bk_scope_id | string | 是 | 资源范围ID, 与bk_scope_type对应, 表示业务ID或者业务集ID |
| name | string | 是 | 凭据名称 |
| type | string | 是 | 凭据类型，取值可为ACCESS_KEY_SECRET_KEY,PASSWORD,USERNAME_PASSWORD,SECRET_KEY |
| description | string | 否 | 凭据描述 |
| credential_access_key | string | 否 | 凭据类型为ACCESS_KEY_SECRET_KEY时填写 |
| credential_secret_key | string | 否 | 凭据类型为ACCESS_KEY_SECRET_KEY/SECRET_KEY时填写 |
| credential_username | string | 否 | 凭据类型为USERNAME_PASSWORD时填写 |
| credential_password | string | 否 | 凭据类型为USERNAME_PASSWORD/PASSWORD时填写 |
| name | string | 是 | 凭证名称 |
| type | string | 是 | 凭证类型，取值可为ACCESS_KEY_SECRET_KEY,PASSWORD,USERNAME_PASSWORD,SECRET_KEY |
| description | string | 否 | 凭证描述 |
| credential_access_key | string | 否 | 凭证类型为ACCESS_KEY_SECRET_KEY时填写 |
| credential_secret_key | string | 否 | 凭证类型为ACCESS_KEY_SECRET_KEY/SECRET_KEY时填写 |
| credential_username | string | 否 | 凭证类型为USERNAME_PASSWORD时填写 |
| credential_password | string | 否 | 凭证类型为USERNAME_PASSWORD/PASSWORD时填写 |


### 请求参数示例
Expand Down Expand Up @@ -67,4 +67,4 @@

| 字段 | 类型 |字段是否一定存在 | 描述 |
|-----------|-------|---------------|---------|
| id | string |是 | 凭据ID |
| id | string |是 | 凭证ID |
2 changes: 1 addition & 1 deletion docs/apidoc/esb/jobv3-confapis/apidocs/zh_hans/create_file_source.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| alias | string | 是 | 文件源别名 |
| type | string | 是 | 文件源类型，当前仅支持蓝鲸制品库，BLUEKING_ARTIFACTORY |
| access_params | object | 是 | 文件源接入参数，根据type传入不同的对象，见后续说明 |
| credential_id | string | 否 | 文件源使用的凭据Id |
| credential_id | string | 否 | 文件源使用的凭证Id |
| file_prefix | string | 否 | Job对从该文件源分发的文件加上的前缀，不传默认不加前缀 |

### access_params
Expand Down
78 changes: 0 additions & 78 deletions docs/apidoc/esb/jobv3-confapis/apidocs/zh_hans/get_credential_detail.md
View file

This file was deleted.

Loading

0 comments on commit ff632d5

Please sign in to comment.