docs: 账单账号功能接口文档补全 #1205
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 |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| ### 描述 | ||
|
|
||
| - 该接口提供版本：v1.6.0+。 | ||
| - 该接口所需权限：一级账号管理。 | ||
| - 该接口功能描述：一级账号录入。 | ||
|
|
||
| ### URL | ||
|
|
||
| POST /api/v1/account/root_accounts/add | ||
|
|
||
| ### 请求参数 | ||
| | 参数名称 | 参数类型 | 必选 | 描述 | | ||
| |--------------|--------|----|--------| | ||
| | name | string | 是 | 名字 | | ||
| | vendor | string | 是 | 云厂商 | | ||
| | email | string | 是 | 邮箱 | | ||
| | managers | string | 是 | 负责人 | | ||
| | bak_managers | string | 是 | 备份负责人 | | ||
| | site | string | 是 | 站点 | | ||
| | dept_id | int | 是 | 组织架构ID | | ||
| | memo | string | 否 | 备忘录 | | ||
| | extension | object | 否 | 扩展字段 | | ||
|
|
||
| #### extension字段说明 | ||
|
|
||
| ##### aws | ||
|
|
||
| | 参数名称 | 参数类型 | 必选 | 描述 | | ||
| |--------------------|--------|----|---------| | ||
| | cloud_account_id | string | 是 | 云账号ID | | ||
| | cloud_iam_username | string | 是 | 云IAM用户名 | | ||
| | cloud_secret_id | string | 是 | 云密钥ID | | ||
| | cloud_secret_key | string | 是 | 云密钥KEY | | ||
|
|
||
| ##### gcp | ||
|
|
||
| | 参数名称 | 参数类型 | 必选 | 描述 | | ||
| |----------------------------|--------|----|----------| | ||
| | cloud_project_name | string | 是 | 云项目名 | | ||
| | cloud_project_id | string | 是 | 云项目ID | | ||
| | cloud_service_account_id | string | 是 | 云服务账号ID | | ||
| | cloud_service_account_name | string | 是 | 云服务账号名 | | ||
| | cloud_service_secret_id | string | 是 | 云服务密钥ID | | ||
| | cloud_service_secret_key | string | 是 | 云服务密钥KEY | | ||
|
|
||
| ##### azure | ||
| | 参数名称 | 参数类型 | 必选 | 描述 | | ||
| |-------------------------|--------|----|--------| | ||
| | display_name_name | string | 是 | 显示名称名 | | ||
| | cloud_tenant_id | string | 是 | 云租户ID | | ||
| | cloud_subscription_id | string | 是 | 云订阅ID | | ||
| | cloud_subscription_name | string | 是 | 云订阅名 | | ||
| | cloud_application_id | string | 是 | 云应用ID | | ||
| | cloud_application_name | string | 是 | 云应用名 | | ||
| | cloud_client_secret_key | string | 是 | 云客户端密钥 | | ||
|
|
||
|
|
||
| ##### huawei | ||
| | 参数名称 | 参数类型 | 必选 | 描述 | | ||
| |------------------------|--------|----|----------| | ||
| | cloud_sub_account_name | string | 是 | 二级账号名 | | ||
| | cloud_sub_account_id | string | 是 | 二级账号ID | | ||
| | cloud_secret_id | string | 是 | 云密钥ID | | ||
| | cloud_secret_key | string | 是 | 云密钥KEY | | ||
| | cloud_iam_user_id | string | 是 | 云IAM用户ID | | ||
| | cloud_iam_username | string | 是 | 云IAM用户名 | | ||
|
|
||
| ##### zenlayer/kaopu | ||
| | 参数名称 | 参数类型 | 必选 | 描述 | | ||
| |------------------|--------|----|-------| | ||
| | cloud_account_id | string | 是 | 云账号ID | | ||
|
|
||
|
|
||
|
|
||
| ### 响应数据 | ||
| ``` | ||
| { | ||
| "code": 0, | ||
| "message": "", | ||
| "data": { | ||
| "id": "xxxx" | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| ### 响应参数说明 | ||
|
|
||
| | 参数名称 | 参数类型 | 描述 | | ||
| |---------|--------|------| | ||
| | code | int32 | 状态码 | | ||
| | message | string | 请求信息 | | ||
| | data | array | 响应数据 | | ||
|
|
||
| #### data | ||
|
|
||
| | 参数名称 | 参数类型 | 描述 | | ||
| |---------------------|--------------|-----------| | ||
| | id | string | AccountID | |
|
|
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,109 @@ | ||
| ### 描述 | ||
|
|
||
| - 该接口提供版本：v1.6.0+。 | ||
| - 该接口所需权限：二级账号查看权限。 | ||
| - 该接口功能描述：获取二级账号。 | ||
|
|
||
| ### URL | ||
|
|
||
| POST /api/v1/account/main_accounts/{account_id} | ||
|
|
||
| ## 请求参数 | ||
| | 参数名称 | 参数类型 | 必选 | 描述 | | ||
| |------------|--------|----|---------| | ||
| | account_id | string | 是 | 二级账号ID。 | | ||
|
|
||
|
|
||
| ### 响应数据 | ||
| ``` | ||
| { | ||
| "code": 0, | ||
| "message": "", | ||
| "data": { | ||
| "id": "xxxx", // id | ||
| "vendor": "aws", // string,云厂商 | ||
| "email": "[email protected]", // 邮箱 | ||
| "cloud_id": "xxx", // 云账号id | ||
| "parent_account_name": "xxx", // 所属一级账号名 | ||
| "parent_account_id": "xxxx", // 所属一级账号id | ||
| "site": "international", // string,站点 | ||
| "business_type": "internal", // string,业务类型 | ||
| "managers": ["xxx","xxx"], // string,负责人 | ||
| "bak_managers": ["xxx","xxx"], // string,备份负责人 | ||
| "dept_id": 1234, // int,组织架构ID | ||
| "op_product_id": 1234, // int,运营产品ID | ||
| "bk_biz_id": 1312, // int,业务ID | ||
| "status": "xxxx", // string,账号状态 | ||
| "memo": "xxxxx", // string,备忘录 | ||
| "creator": "xx", // string,创建者 | ||
| "reviser": "", // string,修改者 | ||
| "created_at": "", // string,创建时间 | ||
| "updated_at": "", // string,修改时间 | ||
| "extension": {} // 混合云差异字段，见extension说明 | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### 响应参数说明 | ||
|
|
||
| | 参数名称 | 参数类型 | 描述 | | ||
| |---------|--------|------| | ||
| | code | int32 | 状态码 | | ||
| | message | string | 请求信息 | | ||
| | data | array | 响应数据 | | ||
|
|
||
| #### data | ||
|
|
||
| | 参数名称 | 参数类型 | 描述 | | ||
| |---------------------|--------------|------------| | ||
| | id | string | 资源ID | | ||
| | vendor | string | 云厂商 | | ||
| | email | string | 邮箱 | | ||
| | cloud_id | string | 云ID | | ||
| | parent_account_name | string | 父账号名称 | | ||
| | parent_account_id | string | 父账号ID | | ||
| | site | string | 站点 | | ||
| | business_type | string | 业务类型 | | ||
| | status | string | 状态 | | ||
| | managers | string array | 主账号管理者列表 | | ||
| | bak_managers | string array | 主账号备份管理者列表 | | ||
| | dept_id | int | 部门ID | | ||
| | op_product_id | int | 运营产品ID | | ||
| | bk_biz_id | int | 业务ID | | ||
| | status | string | 状态 | | ||
| | memo | string | 备注 | | ||
| | creator | string | 创建者 | | ||
| | reviser | string | 修改者 | | ||
| | created_at | string | 创建时间 | | ||
| | updated_at | string | 修改时间 | | ||
| | extension | object | 扩展字段 | | ||
|
|
||
| #### extension | ||
|
|
||
| ##### aws | ||
|
|
||
| | 参数名称 | 参数类型 | 描述 | | ||
| |-------------------------|--------|--------| | ||
| | cloud_main_account_name | string | 二级账号名 | | ||
| | cloud_main_account_id | string | 二级账号ID | | ||
|
|
||
| ##### gcp | ||
|
|
||
| | 参数名称 | 参数类型 | 描述 | | ||
| |--------------------|--------|-------| | ||
| | cloud_project_name | string | 云项目名 | | ||
| | cloud_project_id | string | 云项目ID | | ||
|
|
||
| ##### azure | ||
|
|
||
| | 参数名称 | 参数类型 | 描述 | | ||
| |-------------------------|--------|------| | ||
| | cloud_subscription_name | string | 订阅名 | | ||
| | cloud_subscription_id | string | 订阅ID | | ||
|
|
||
| ##### huawei/zenlayer/kaopu | ||
| | 参数名称 | 参数类型 | 描述 | | ||
| |-------------------------|--------|--------| | ||
| | cloud_main_account_name | string | 二级账号名 | | ||
| | cloud_main_account_id | string | 二级账号ID | | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
文件名有两个.md扩展名