华为云用户手册

AddOrUpdateRule 表1 参数说明 参数 是否必选 参数类型 描述 ruleType 否 String 类型。 WHITE表示白名单。 BLACK表示黑名单。 attribute 否 String 如果是tag_xxx开头，则按Tag过滤attribute属性。 否则，则按ServiceId、AppId、ServiceName、Version、Description、Level、Status过滤。 pattern 否 String 匹配规则，正则表达式，长度1到64个字符。 description 否 String rule的描述。 字符长度不超过256个字符。 父主题： 公共请求参数

MetricData 表1 参数说明 参数 是否必选 参数类型 描述 name 是 String 服务名称。 appId 是 String 应用Id。 serviceId 否 String 服务Id。 version 是 String 服务版本号。 instanceId 否 String 实例Id。 instance 是 String 实例名称。 thread 否 String 线程数。 cpu 否 String CPU使用率。 memory 否 String 内存。 interfaces 否 表2 实例包含的详细接口数据。 serviceId和instanceId两个参数必须同时存在或者同时不存在。 表2 items参数说明 参数 是否必选 参数类型 描述 items 否 FunctionMetricInfo 接口级别聚合指标数据。 父主题： 参数说明

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

URI DELETE /v1/{project_id}/git/files/{namespace}/{project}/{path} 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法，请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称，如果含有“/”，需要将“/”替换为“:”。获取方法，请参考获取命名空间下所有项目。 path 是 String 文件路径，需要将“/”替换为“:”。获取方法，请参考获取仓库文件目录。 表2 查询参数 参数 是否必选 参数类型 描述 ref 是 String 分支名称或者tag名称或者commit哈希。 message 是 String commit信息。 sha 是 String 文件的Blob SHA，可通过获取仓库文件内容API获取。

URI POST /v1/{project_id}/git/repos/{namespace}/{project}/hooks 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法，请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称，如果含有“/”，需要将“/”替换为“:”。获取方法，请参考获取命名空间下所有项目。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 X-Repo-Auth 是 String 授权名称，通过获取仓库授权列表获取对应的授权名称。 表3 请求Body参数 参数 是否必选 参数类型 描述 secret 是 String 用于验证接收到的payloads的字符串。 url 是 String hook触发时回调的url。

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

响应消息 表4 响应参数 参数 参数类型 描述 authorization Object 授权结构体，请参考表5。 表5 authorization 参数 参数类型 描述 name String 授权名称。 repo_type String 仓库类型。 取值范围：codearts、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 GET /v1/{project_id}/git/repos/{namespace}/{project}/tags 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法，请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称，如果含有“/”，需要将“/”替换为“:”。获取方法，请参考获取命名空间下所有项目。

响应示例 { "authorization": { "name": "pass1", "repo_type": "bitbucket", "repo_host": "https://api.bitbucket.org", "repo_home": "https://bitbucket.org/%7B63cc78de-***********-9505c0335f96%7D/", "repo_user": "bucket-ljn", "avartar": "https://secure.gravatar.com/avatar/05a7b4a2302750*********cf64?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FB-2.png", "token_type": "password", "create_time": 1634119075119, "update_time": 1634119075119, "status": 0 }}

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

状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 200 - 操作成功。 304 Not Modified 未修改，所请求的资源未修改返回此状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 服务器拒绝执行客户端的请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 父主题： 附录

调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为 IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "region_id", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 微服务引擎专享版ID。 name String 微服务引擎专享版名称。 jobId Integer 微服务引擎专享版执行任务ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

响应参数 状态码： 200 表3 响应Body体 参数 参数类型 描述 id Integer 任务ID。 engineId String 微服务引擎专享版ID。 type String 任务类型。 Create：创建引擎。 Delete：删除引擎。 Upgrade：升级引擎。 Configure：变更引擎配置。 description String 任务描述。 status String 任务当前执行状态。 Init：初始化。 Executing：执行中。 Error：执行失败。 Timeout：执行超时。 Finished：结束。 scheduling Integer 任务是否正在执行，0表示不在执行，1表示执行中。 createUser String 任务创建者。 startTime Integer 任务开始执行时间。 endTime Integer 任务结束时间。 context String 任务执行上下文。 tasks Array of TaskSteps objects 任务包含处理阶段。 表4 TaskSteps 参数 参数类型 描述 taskName String 处理阶段名称。 taskNames Array of String 当前处理阶段包含的处理步骤名称列表。 status String 任务处理阶段状态。 startTime Integer 任务处理阶段开始时间。 endTime Integer 任务处理阶段结束时间。 taskExecutorBrief Object 任务元数据。 tasks Array of Task objects 处理阶段包含的子任务。 表5 TaskExecutorBrief 参数 参数类型 描述 duration Integer 子任务持续时长。 description String 子任务描述。 表6 Task 参数 参数类型 描述 jobId Integer 子任务所属任务ID。 id Integer 子任务ID，使用uuid。 type String 子任务的类型。 assigned String 子任务的执行者。 taskName String 子任务名称。 engineName String 子任务所属引擎名称。 taskOrder Integer 子任务执行的顺序，从小到大。 status String 子任务状态。 startTime Integer 子任务开始时间。 endTime Integer 子任务结束时间。 createTime Integer 子任务创建时间。 updateTime Integer 子任务更新时间。 timeout Integer 子任务是否超时。 log String 子任务详细信息，执行过程中产生的辅助信息。 output String 子任务输出信息。 taskExecutorBrief Object 子任务元数据。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

响应示例 {"id": 12339,"engineId": "ad76972c-a743-4770-859c-c98a680f4d98","type": "Create","description": "","status": "Finished","scheduling": 0,"createUser": "test","startTime": 1636540095901,"endTime": 1636540460230,"context": "","tasks": [{"taskName": "resourcePrepare","taskNames": ["TenantTaskExecutor"],"status": "Finished","startTime": 1636540100216,"endTime": 1636540110215,"taskExecutorBrief": {"duration": 60000,"description": "资源准备"},"tasks": [{"jobId": 12339,"id": 89117,"type": "Create","assigned": "","taskName": "TenantTaskExecutor","engineName": "test","taskOrder": 0,"status": "Init","startTime": 1636540100216,"endTime": 1636540110215,"createTime": 1636540095910,"updateTime": 1636540110230,"timeout": -1,"log": "","output": "{}","taskExecutorBrief": {"duration": 60000,"description": "租户处理"}}]}]}

URI GET /v2/{project_id}/enginemgr/engines/{engine_id}/jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识，字符长度为1~64位，获取方法请参考获取项目ID。 engine_id 是 String 微服务引擎专享版ID，获取方法请参考查询微服务引擎专享版列表。 job_id 是 String 微服务引擎专享版ID，获取方法请参考查询微服务引擎专享版详情。

URI POST /v1/{project_id}/kie/download 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识，字符长度为1~64位，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 label 否 String 按label过滤项导出，格式为：{标签key}:{标签value}。 match 否 String 对label过滤项的匹配选项。 如果值为exact表示严格匹配，包括label个数和内容相等。 不填表示包含匹配。

响应示例 查询成功 { "metadata": { "version": "2.0.0" }, "data": [ { "id": "0bdfddb8-c4f9-4a88-8360-07a8a616a804", "key": "2", "labels": { "2": "2" }, "value": "2", "status": "enabled", "value_type": "text" }, { "id": "34befef9-7f3a-4394-85f9-142622a11b1d", "key": "1", "labels": { "1": "1" }, "value": "1", "status": "enabled", "value_type": "text" } ]}

响应示例 {"total": 1,"data": [{"id": "891bf21a-4024-4f47-b38c-bd259ca8f10a","name": "test","enterpriseProjectId": "0","enterpriseProjectName": "default","type": " CS E_SHARE","description": "","flavor": "cse.s1.medium2","payment": "0","authType": "RBAC","status": "Available","externalAddress": "192.168.0.169","serviceEndpoint": {"kie": {"masterEntrypoint": "https://192.168.0.169:30110","masterEntrypointIpv6": "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30110","slaveEntrypoint": null,"slaveEntrypointIpv6": null,"type": "REGISTRY"}, "serviceCenter": { "masterEntrypoint": "https://192.168.0.169:30100", "masterEntrypointIpv6": "https://[2407:c080:11f0:11:b11d:675c:97ab:65f6]:30100", "slaveEntrypoint": null, "slaveEntrypointIpv6": null, "type": "REGISTRY" }},"publicAddress": "","publicServiceEndpoint": {"kie": {"masterEntrypoint": "","masterEntrypointIpv6": "","slaveEntrypoint": "","slaveEntrypointIpv6": "","type": "REGISTRY"}, "serviceCenter": { "masterEntrypoint": "", "masterEntrypointIpv6": "", "slaveEntrypoint": "", "slaveEntrypointIpv6": "", "type": "REGISTRY" }},"totalInstance": 200,"usedInstance": 0,"availableInstance": 200,"version": "2.3.1","latestVersion": "2.3.3","createTime": 1635576800332,"dueTo": 4102415999000,"latestJobId": 12339,"engineAdditionalActions": ["Retry"],"specType": "CSE2","reference": {"vpc": "vpc-test", "vpcId": "09902850-9454-4715-9764-018f0c3701hy","azList": ["test"],"networkId": "88550801-e892-4f8e-b21b-f7147f604f69","subnetCidr": "192.168.0.0/24","subnetCidrV6": "2407:c080:11f0:11::/64","subnetGateway": "192.168.0.2","publicIpId": null,"serviceLimit": 200,"instanceLimit": 200,"inputs": {"is_arm_cluster": "false","nodeFlavor": "s6.large.2"}}}]}

URI GET /v2/{project_id}/enginemgr/engines 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识，字符长度为1~64位，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 limit 否 Integer 每页数据大小 type 否 String 查询的引擎类型：CSE、CSE_SHARE。

URI GET /v2/{project_id}/enginemgr/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识，字符长度为1~64位，获取方法请参考获取项目ID。 表2 query参数 参数 是否必选 参数类型 描述 specType 否 String 查询1.x版本CSE引擎支持规格时，将specType设置为CSE。 查询2.x版本CSE引擎支持规格时，将specType设置为CSE2。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 当前微服务引擎专享版规格总个数。 data Array of Flavor objects 微服务引擎专享版规格详情。 表5 Flavor 参数 参数类型 描述 flavor String 微服务引擎专享版规格。 description String 微服务引擎专享版规格描述。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

请求示例 导入配置文件，当存在相同配置时，会强制导入覆盖重复项，按body的label导入。 POST https://{endpoint}/v1/{project_id}/kie/file/override=force----WebKitFormBoundary7MA4YWxkTrZu0gWContent-Disposition: form-data; name="upload_file"; filename="custom_1663124521493.json"Content-Type: application/json----WebKitFormBoundary7MA4YWxkTrZu0gW

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 x-engine-id 是 String 待上传配置的引擎id，获取方法请参考查询微服务引擎专享版列表。 X-Enterprise-Project-ID 否 String 企业项目id。 如果不配置此参数，则默认企业项目为“default”，ID为0。 表4 请求Body参数 参数 是否必选 参数类型 描述 upload_file 是 File 导入的文件，文件名格式为：fileName.json 文件格式为： { "data": [ { "key": "keyItem1", "value": "valueItem1", "labels":{ "1": "1" }, "status": "enabled", "value_type": "text" } ]}

响应示例 查询成功 { "success": [ { "id": "7e2d346e-d907-4871-bf51-a17fc7e52ad4", "key": "2", "value": "2", "value_type": "text", "create_revision": 3, "update_revision": 3, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "2": "2", "environment": "production" } }, { "id": "907b3891-c691-4ae0-816f-e91eba705e28", "key": "1", "value": "1", "value_type": "text", "create_revision": 4, "update_revision": 4, "status": "enabled", "create_time": 1636374809, "update_time": 1636374809, "labels": { "1": "1", "environment": "production" } } ], "failure": []}

URI POST /v1/{project_id}/kie/file 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户子项目的唯一标识，字符长度为1~64位，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 override 是 String force：强制导入，会覆盖重复项。 skip：跳过导入，会跳过重复项。 abort：终止导入，遇到重复项会停止导入操作。 label 否 String 指定label导入，格式为：{标签key}:{标签value}，如果不填则按body的label导入。

响应示例 { "url": "https://github.com/login/oauth/authorize?client_id=2993bccf255673ba****&redirect_uri=https%3A%2F%2Fconsole.huaweicloud.com%2Fservicestage%2Foauth%3Frepo_type%3Dgithub&state=%242a%2410%24%2FMOymg0euuGH%2FJNWIJI3FeSVZhTUVj%2FF7r52mqpUKcYXz7f6.****&scope=read%3Auser%20repo%20write%3Arepo_hook"}

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

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