华为云用户手册

响应参数 表8 响应参数 名称 参数类型 说明 instance Object 实例信息。 详情请参见表9。 job_id String 实例创建的任务ID。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 表9 instance说明 名称 参数类型 说明 id String 实例ID。 name String 实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围：4~64个字符之间，必须以字母开头，不区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。 status String 实例状态。如BUILD，表示创建中。 仅创建按需实例时会返回该参数。 datastore Object 数据库信息。 详情请参见表10。 ha Object 数据库部署形态。 详情请参见表11。 replica_num Integer 实例副本集数。 port String 数据库端口信息，与请求参数相同。 backup_strategy Object 自动备份策略。 详情请参见表12。 enterprise_project_id String 项目标签。 flavor_ref String 规格码，取值范围：非空。 volume Object volume信息。 详情请参见表13。 region String 区域ID。 availability_zone String 可用区ID。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 实例所属的安全组。 charge_info Object 付费方式信息。 详情请参见表14。 表10 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎，返回值如下： GaussDB version String 数据库版本。 表11 ha字段数据结构说明 名称 参数类型 说明 mode String GaussDB分布式模式支持取值：enterprise(企业版) ，combined(基础版混合部署)，主备版取值:centralization_standard，不区分大小写。 replication_mode String 备机同步模式。固定取值为sync，表示数据同步方式为“同步模式”。 consistency String GaussDB的预留参数：指定事务一致性类型，取值范围： strong：强一致性。 eventual：最终一致性。 consistency_protocol String 指定副本一致性协议类型，取值范围：quorum 、paxos。不填时，默认为quorum。 表12 backup_strategy字段数据结构说明 名称 参数类型 说明 start_time String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 取值示例： 08:00-09:00 23:00-00:00 如果请求体中不填写“backup_strategy”字段，则响应体中 “start_time”默认返回“02:00-03:00”。 keep_days Integer 指定已生成备份文件的可保存天数。 取值范围：1～732。如果请求体中不填写“backup_strategy”字段，则响应体中 “keep_days”默认填写为7天。 表13 volume字段数据结构说明 名称 参数类型 说明 type String 磁盘类型。 取值如下，区分大小写： ULTRAHIGH，表示SSD盘。 ESSD,表示极速云盘。 size Integer 磁盘大小。 表14 charge_Info字段数据结构说明 名称 参数类型 说明 charge_mode String 计费模式。 postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。 period_type String 订购周期类型。month：包月。year：包年。说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。当“period_type”为“year”时，取值为1~3。 is_auto_renew Boolean 创建包周期实例时可指定,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。 true,表示自动续订。 false,表示不自动续订,默认为该方式。 is_auto_pay Boolean 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。

弹性资源池界面添加队列 在左侧导航栏单击“弹性资源池”，可进入弹性资源池管理页面。 选择要操作的弹性资源池，在“操作”列，单击“添加队列”。 在“添加队列”界面，首先需要配置队列的基础配置，具体参数信息如下。 表1 弹性资源池添加队列基础配置 参数名 参数描述 名称 弹性资源池添加的队列名称。 类型 SQL队列：用于运行SQL作业。 通用队列：用于运行Spark作业 、Flink 作业。 执行引擎 如果队列类型选择为“SQL队列”，则可以选择队列引擎是：spark或者trino 企业项目 选择队列的企业项目。弹性资源池支持添加不同企业项目的队列资源。 企业项目是一种云资源管理方式，企业项目管理服务提供统一的云资源按项目管理，以及项目内的资源管理、成员管理。 关于如何设置企业项目请参考《企业管理用户指南》。 说明： 只有开通了企业管理服务的用户才显示该参数。 描述 弹性资源池添加队列的描述信息。 标签 使用标签标识云资源。包括标签键和标签值。如果您需要使用同一标签标识多种云资源，即所有服务均可在标签输入框下拉选择同一标签，建议在标签管理服务（TMS）中创建预定义标签。 如您的组织已经设定 DLI 的相关标签策略，则需按照标签策略规则为资源添加标签。标签如果不符合标签策略的规则，则可能会导致资源创建失败，请联系组织管理员了解标签策略详情。 具体请参考《标签管理服务用户指南》。 说明： 最多支持20个标签。 一个“键”只能添加一个“值”。 每个资源中的键名不能重复。 标签键：在输入框中输入标签键名称。 说明： 标签的键的最大长度为128个字符，标签的键可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格，不能以_sys_开头。 标签值：在输入框中输入标签值。 说明： 标签值的最大长度为255个字符，标签的值可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格。 单击“下一步”，在“扩缩容策略”界面配置当前队列在弹性资源池的扩缩容策略。 图1 添加队列时配置扩缩容策略 单击“新增”，可以添加不同优先级、时间段、“最小CU”和“最大CU”扩缩容策略。每条扩缩容策略的参数说明如下： 表2 扩缩容策略参数说明 参数名 参数描述 优先级 当前弹性资源池中的优先级数字越大表示优先级越高。当前优先级支持的范围为：1到100。 时间段 时间段设置仅支持整点，左侧为开始时间，右侧为结束时间。请注意以下说明： 时间区间包括开始时间，不包括结束时间即[开始时间, 结束时间)。 例如当前选择的时间段范围为：01--17，则表示当前扩缩容规则生效时间范围为[01,17)。 同一队列不同优先级的时间段区间不能有交集。 最小CU 当前扩缩容策略支持的最小CU数。 在全天的任意一个时间段内，弹性资源池中所有队列的最小CU数之和必须小于等于弹性资源池的最小CU数。 当队列的最小CUs小于16CUs时，在队列属性中设置的“最大spark driver实例数”和“最大预拉起spark driver实例数”不生效。了解队列属性设置。 最大CU 当前扩缩容策略支持的最大CU数。 在全天的任意一个时间段内，弹性资源池中任意一个队列的最大CU必须小于等于弹性资源池的最大CU。 首条扩缩容策略是默认策略，不能删除和修改时间段配置。 Flink作业不支持触发弹性资源池队列的自动扩缩容。 单击“确定”完成添加队列配置。弹性资源池队列添加完成后，可以参考调整弹性资源池中队列的扩缩容策略查看弹性资源池添加的所有队列配置和策略信息。

约束限制 DLI服务预置了名为“default”的队列供用户体验，资源的大小按需分配。运行作业时按照用户每个作业的数据扫描量（单位为“GB”）收取计算费用。 队列类型： SQL类型队列：SQL队列支持提交Spark SQL作业。 通用队列：支持Spark程序、Flink SQL、Flink Jar作业。 不支持队列类型切换，如需使用其他队列类型，请重新购买新的队列。 不支持切换队列的计费模式。 队列不支持切换区域。 16CUs队列不支持扩容和缩容。 64CUs队列不支持缩容。 创建队列时，仅支持包年包月队列和按需专属队列选择跨AZ双活，且跨AZ的队列价格为单AZ模式下的2倍。 新创建的队列需要运行作业后才可进行扩缩容。 DLI队列不支持访问公网。 如有访问公网诉求请您参考配置DLI 队列与公网网络连通。

迁移数据至DLI或配置DLI跨源访问 当需要将来自不同源的数据进行集中存储和处理时，迁移数据至DLI可以提供一个统一的数据平台。 您可以参考使用 CDM 迁移数据至DLI迁移数据至DLI后再提交作业。 如果业务需求需要实时访问和处理来自不同数据源的数据，跨源访问可以减少数据的复制和延迟。 跨源访问的必要条件包括“DLI与数据源网络连通”、“DLI可获取数据源的访问凭证”： DLI与数据源网络连通：您可以参考配置DLI与数据源网络连通（增强型跨源连接）配置DLI与数据源的网络连通。 管理数据源的凭证： 您可以使用DLI提供的跨源认证功能管理访问指定数据源的认证信息。 适用范围：SQL作业、Flink 1.12作业场景。具体操作请参考使用DLI的跨源认证管理数据源访问凭证。 您还可以使用DEW管理数据源的访问凭证，并通过“自定义委托”方式授予DLI访问DEW服务的权限。 适用范围：Spark 3.3.1及以上版本、Flink 1.15及以上版本。具体操作请参考使用DEW管理数据源访问凭证和配置DLI访问其他云服务的委托权限。

使用DLI提交作业 DLI提供一站式的流处理、批处理、交互式分析的Serverless融合处理分析服务，支持多种作业类型以满足不同的数据处理需求。 表1 DLI支持的作业类型 作业类型 说明 适用场景 SQL作业 适用于使用标准SQL语句进行查询的场景。通常用于结构化数据的查询和分析。 详细操作请参考创建并提交SQL作业。 适用于 数据仓库 查询、报表生成、OLAP（在线分析处理）等场景。 Flink作业 专为实时数据流处理设计，适用于低时延、需要快速响应的场景。适用于实时监控、在线分析等场景。 Flink OpenSource作业：DLI提供了标准的连接器（connectors）和丰富的API，便于快速与其他数据系统的集成。详细操作请参考创建Flink OpenSource SQL作业。 Flink Jar作业：允许用户提交编译为Jar包的Flink作业，提供了更大的灵活性和自定义能力。 适合需要自定义函数、UDF（用户定义函数）或特定库集成的复杂数据处理场景。可以利用Flink的生态系统，实现高级流处理逻辑和状态管理。详细操作请参考创建Flink Jar作业。 适用于实时数据监控、实时推荐系统等需要快速响应的场景。 Flink Jar作业适用于需要自定义流处理逻辑、复杂的状态管理或特定库集成的数据分析场景。 Spark作业 可通过交互式会话（session）和批处理（batch）方式提交计算任务。通过在DLI提供的弹性资源池队列上提交作业，简化了资源管理和作业调度。 支持多种数据源和格式，提供了丰富的数据处理能力，包括但不限于SQL查询、机器学习等。详细操作请参考创建Spark作业。 适用于大规模数据处理和分析，如机器学习训练、 日志分析 、大规模数据挖掘等场景。 管理Jar作业的程序包 DLI允许用户提交编译为Jar包的Flink或Spark作业，Jar包中包含了Jar作业执行所需的代码和依赖信息，用于在数据查询、数据分析、机器学习等特定的数据处理任务中使用。通过DLI管理控制台可以管理作业所需的呈现包。 在提交Spark Jar和Flink Jar类型的作业前，需要将程序包上传至OBS，然后在DLI服务中创建程序包，并将程序包与数据和作业参数一起提交以运行作业。管理Jar作业程序包。 Spark3.3.1及以上版本、Flink1.15及以上版本在创建Jar作业时支持直接配置OBS中的程序包，不支持读取DLI程序包。

创建 IAM 用户并授权使用DLI 如果您是企业用户，并计划使用IAM对您所拥有的DLI资源进行精细的权限管理，请创建IAM用户并授权使用DLI。具体操作请参考创建IAM用户并授权使用DLI。 首次使用DLI您需要根据控制台的引导更新DLI委托，用于将操作权限委托给DLI服务，让DLI服务以您的身份使用其他云服务，代替您进行一些资源运维工作。该委托包含获取IAM用户相关信息、跨源场景访问和使用VPC、子网、路由、对等连接的权限、作业执行失败需要通过 SMN 发送通知消息的权限。详细委托包含的权限请参考配置DLI云服务委托权限。

创建执行作业所需的计算资源和元数据 使用DLI提交作业前，您需要先创建弹性资源池，并在弹性资源池中创建队列，为提交作业准备所需的计算资源。请参考DLI弹性资源池与队列简介创建弹性资源池并添加队列。 您还可以通过 自定义镜像 增强DLI的计算环境，通过下载DLI提供的基础镜像再按需制作自定义镜像，将作业运行需要的依赖（文件、jar包或者软件）、私有能力等内置到自定义镜像中，可以改变Spark作业和Flink作业的容器运行环境，增强作业的功能、性能。 例如，在自定义镜像中加入机器学习相关的Python包或者C库，可以通过这种方式帮助用户实现功能扩展。创建自定义镜像请参考使用自定义镜像增强作业运行环境。 DLI元数据是SQL作业、Spark作业场景开发的基础。在执行作业前您需要根据业务场景定义数据库和表。 Flink支持动态数据类型，可以在运行时定义数据结构，不需要事先定义元数据。 定义您的数据结构，包括数据目录、数据库、表。请参考创建DLI元数据。 创建必要的存储桶来存储作业运行过程中产生的临时数据：作业日志、作业结果等。请参考配置DLI作业桶。 配置元数据的访问权限。请参考在DLI控制台配置数据库权限、在DLI控制台配置表权限。

响应示例 { "environments": [ { "id": "00078e9d-a61c-476e-ac63-a10c9cb2638e", "name": "development-env", "alias": null, "description": "", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "charge_mode": "provided", "deploy_mode": "container", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "base_resources": [ { "id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "type": "cce", "name": "cce-test" } ], "optional_resources": [ { "id": "9963306a-791e-468c-9306-cf80a9d00298", "type": "elb", "name": "elb-2dd2" } ], "creator": "ss-test", "create_time": 1610418873730, "update_time": 1610418873730 } ], "count": 1 }

URI GET /v2/{project_id}/cas/environments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 Integer 指定偏移量，表示查询第n条数据后的结果。 order_by 否 String 排序字段，默认按创建时间排序。 排序字段支持枚举值：create_time、name、update_time。传的值不在支持的枚举值范围内的话按默认排序字段排序。 order 否 String 排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 环境总数。 environments Array of objects 环境参数，请参考表5。 表5 environments 参数 参数类型 描述 id String 环境ID。 name String 环境名称。 alias String 环境别名。 description String 环境描述。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 charge_mode String 收费模式。 deploy_mode String 环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。 vpc_id String 虚拟私有云ID。 base_resources Array of objects 基础资源，请参考表6。 optional_resources Array of objects 可选资源，请参考表6。 creator String 创建人。 create_time Integer 创建时间。 update_time Integer 修改时间。 表6 resources 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 基础资源：cce、ecs、as。 可选资源：rds、dcs、elb、cse等其他类型。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。

URI DELETE /v3/{project_id}/cas/environments/{environment_id}/addons/{addon_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 environment_id 是 String 环境ID。获取方法，请参考获取所有环境。 addon_id 是 String 插件ID。获取方法，请参考查询插件列表。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

URI GET /v2/{project_id}/cas/applications/{application_id}/components 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 String 指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 String 指定偏移量。 order_by 否 String 排序字段，默认按创建时间排序。 排序字段支持枚举值：create_time、name、update_time。 order 否 String 排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

响应示例 { "components": [ { "id": "384eb8d4-c193-4d84-9558-6fda2366b536", "name": "mycomponent", "runtime": "Java8", "category": "MicroService", "sub_category": "Java Chassis", "description": "", "project_id": "384eb8d4-c193-4d84-9558-6fda23698536", "application_id": "a8f7eed5-0aa0-4251-9723-c9119a6bf56d", "source": { "kind": "artifact", "spec": { "storage": "obs", "type": "package", "url": "obs://myapp/demo.jar", "properties": { "bucket": "myapp", "key": "demo.jar", "endpoint": "https://obs.region_id.external_domain_name.com" } } }, "build": { "id": "w3dpv7p0t1vpxvey5hjb22iuwxway1vupwx0nae1", "parameters": { "artifact_namespace": "ns", "use_public_cluster": true } }, "status": 0, "creator": "test_user", "create_time": 1610333934288, "update_time": 1610333934288 } ], "count": 1 }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息 表3 响应参数 参数 参数类型 描述 flavors Array of objects 规格参数，请参考表4。 表4 flavors 参数 参数类型 描述 flavor_id String 规格ID storage_size String 存储大小 num_cpu String CPU限制 num_cpu_init String CPU初始 memory_size String 内存限制 memory_size_init String 内存初始 label String 展示标签 custom boolean 是否是自定义资源规格

响应示例 { "flavors": [ { "flavor_id": "MICRO-5G:0.5C:1G", "storage_size": "5G", "num_cpu": "500m", "num_cpu_init": "200m", "memory_size": "1Gi", "memory_size_init": "200Mi", "label": "Micro: 5G Storage, 0.5 CPU, 1G Memory", "custom": false } ] }

响应示例 { "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", "name": "dev-env", "alias": null, "description": "develop environment", "project_id": "bf8523d898b64e4eb956e3be3555ca16", "enterprise_project_id": "0", "charge_mode": "provided", "deploy_mode": "container", "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", "base_resources": [ { "id": "211112333sd332w23322332", "type": "cce" } ], "optional_resources": null, "creator": "string", "create_time": 1578984198394, "update_time": 1578984198394 }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息 表3 响应参数 参数 参数类型 描述 id String 环境ID。 name String 环境名称。 alias String 环境别名。 description String 环境描述。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 charge_mode String 收费模式。 deploy_mode String 环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。 vpc_id String 虚拟私有云ID。 base_resources Array of objects 基础资源，请参考表4。 optional_resources Array of objects 可选资源，请参考表4。 creator String 创建人。 create_time Integer 创建时间。 update_time Integer 修改时间。 表4 resources 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 基础资源：cce、ecs、as。 可选资源：rds、dcs、elb、cse等其他类型。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应示例 { "instances": [ { "id": "11eddb33-140b-4e51-b1e2-6ec265373ca3", "application_id": "4d92833a-fa05-4fc0-a761-e67620022310", "application_name": "test-app", "component_id": "1cfdda6f-84cd-4ead-8e09-628fabf662e2", "component_name": "test-com", "name": "test-micro-test-env-7iafjk", "environment_id": "61b81021-21d5-42f3-b80e-0b6bd10dbf7d", "environment_name": "test-env", "platform_type": "cce", "version": "1.0.0", "artifacts": { "test-micro": { "storage": "obs", "type": "package", "url": "obs://myapp/demo.jar", "properties": { "bucket": "myapp", "key": "demo.jar", "endpoint": "https://obs.region_id.external_domain_name.com" }, "auth": "iam", "version": "1.0.0", } }, "create_time": 1610331819996, "update_time": 1610331830398, "creator": "test_user", "status_detail": { "status": "RUNNING", "replica": 1, "available_replica": 1, "fail_detail": null, "last_job_id": "JOB7bc0366c-dc43-41f9-b65f-8d6078038488", "last_job_status": "SUCCEEDED", "enterprise_project_id": "0" } } ], "count": 1 }

URI GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 component_id 是 String 组件ID。获取方法，请参考获取应用所有组件。 表2 查询参数 参数 是否必选 参数类型 描述 maxWaitTime 否 int 用户自定义整体启动时间。 limit 否 Integer 指定个数，取值[0, 100]或者1000，指定的值不在该范围内的话相当于赋值为10。默认1000，用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 Integer 指定偏移量。 order_by 否 String 排序字段，默认按创建时间排序。 排序字段支持枚举值：create_time、name、version、update_time。 order 否 String 排序方式。 desc，降序排序，默认为desc。 asc，升序排序。

响应示例 { "authorization": { "name": "auth1", "repo_type": "github", "repo_host": "https://api.github.com", "repo_home": "https://github.com/tom-repo", "repo_user": "repo", "avartar": "https://avatars.githubusercontent.com/u/73919200?v=4", "token_type": "oauth", "create_time": 1649758626858, "update_time": 1649758626858, "status": 0 } }

响应消息 表5 响应参数 参数 参数类型 描述 authorization Object 授权结构体，请参考表6。 表6 authorization 参数 参数类型 描述 name String 授权名称。 repo_type String 仓库类型。 取值范围：github、gitlab、gitee、bitbucket。 repo_host String 仓库地址。 repo_home String 您的仓库主页。 repo_user String 您的仓库用户名。 avartar String 您的仓库头像。 token_type String 仓库授权方式。 create_time Long 仓库授权创建时间戳。 update_time Long 仓库授权修改时间戳。 status Integer 仓库授权状态。 0：正常 1：过期 2：未认证。

URI POST /v1/{project_id}/git/auths/{repo_type}/oauth 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 repo_type 是 String 仓库类型。 取值范围：CodeArts、Gitee、GitHub、BitBucket、GitLab。 表2 查询参数 参数 是否必选 参数类型 描述 tag 否 String 站点标签。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 授权名称。 code 是 String git仓库授权后，重定向返回的url里面的code参数。 state 是 String git仓库授权后，一次性的认证编码和随机串。 code和state参数值获取方法： 在浏览器地址栏中输入访问获取授权重定向URL接口获取到的URL并回车。 在登录页面输入您的代码仓库账号和密码。 如果您已经登录代码仓库，则无需执行这一步。 在华为云控制台登录页面输入账号和密码，单击“登录”。 如果您已经登录华为云控制台，则无需执行这一步。 等待页面显示新建授权失败后，复制地址栏的URL。 例如： https://console.huaweicloud.com/servicestage/oauth?repo_type=github&code=04bed2df009f3fc9***c&state=%242a%2410%24.uQYThj5yKFs51w9s9ajeuQ0NSGshPH7IUfXoZLPlz7J%2FoAJ8B*** 对获取到的URL进行URL解码，获得解码后的URL。 示例如下： https://console.huaweicloud.com/servicestage/oauth?repo_type=github&code=04bed2df009f3fc9***c&state=$2a$10$.uQYThj5yKFs51w9s9ajeuQ0NSGshPH7IUfXoZLPlz7J/oAJ8B*** 获取其中code和state对应的参数值。 获取到的state参数值为一次性的认证编码和随机串，仅支持使用一次。如需再次调用本接口创建OAuth授权，请再次执行获取授权重定向URL获取URL并参考本方法获取code和state参数值。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。