华为云用户手册

响应消息 表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：未认证。

响应示例 { "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 }}

HealthCheck 表1 参数说明 参数 是否必选 参数类型 描述 mode 是 String check模式，push/pull。 port 否 Integer 端口，字符长度不超过65536。正则表达式为^[0-9]*$。 interval 是 Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。字符长度不超过4294967296。正则表达式为^[0-9]+$。 times 是 Integer 最大尝试请求次数，字符长度不超过4294967296。正则表达式为^[0-9]+$。 父主题： 参数说明

FunctionMetricInfo 表1 参数说明 参数 是否必选 参数类型 描述 AggregateMetricInfo 否 Object 聚合指标数据。 l995 否 Integer 99.5%的请求低于此值。 l99 否 Integer 99%的请求低于此值。 l90 否 Integer 90%的请求低于此值。 l75 否 Integer 75%的请求低于此值。 l50 否 Integer 50%的请求低于此值。 l25 否 Integer 25%的请求低于此值。 l5 否 Integer 5%的请求低于此值。 父主题： 参数说明

响应示例 {"id": "891bf21a-4024-4f47-b38c-bd259ca8f10a","name": "test","description": "","authType": "RBAC","flavor": "cse.s1.medium2","payment": "0","version": "2.3.1","latestVersion": "2.3.3","status": "Creating","beDefault": true,"createUser": "test","createTime": 1635576800332,"cceSpec": {"id": 7465,"engineId": "891bf21a-4024-4f47-b38c-bd259ca8f10a","specType": "CCE","cluster": null,"clusterId": "41115a6f-912f-11eb-9af9-0255ac100188","clusterNodes": {"clusterNodes": [{"id": "c13aaf5c-2192-421c-8e03-522e2b9a06b5","az": "test","ip": "172.31.25.277","label": "test","status": "Active"}]},"flavor": null,"region": "test","version": "","extendParam": ""},"externalEntrypoint": {"externalAddress": "192.168.0.169","publicAddress": "","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" }},"publicServiceEndpoint": {"kie": {"masterEntrypoint": "https://192.168.0.169:30110","masterEntrypointIpv6": null,"slaveEntrypoint": null,"slaveEntrypointIpv6": null,"type": "REGISTRY"}, "serviceCenter": { "masterEntrypoint": "https://192.168.0.169:30100","masterEntrypointIpv6": null,"slaveEntrypoint": null,"slaveEntrypointIpv6": null,"type": "REGISTRY" }}},"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"}},"latestJobId": 12339,"enterpriseProjectId": "0","enterpriseProjectName": "default","engineAdditionalActions": ["Retry"],"specType": " CS E2","type": "CSE","projectId": "string","vmIds": [""]}

请求示例 { "dependencies": [ { "consumer": { "environment": "", "appId": "default", "serviceName": "test1", "version": "1.0.0" }, "providers": [ { "environment": "", "appId": "default", "serviceName": "test", "version": "1.0.0" } ] } ]}

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 dependencies 是 Arrayof objects 规则的集合，请参考表4。列表长度为1-100。 表4 MicroServiceDependency 参数 是否必选 参数类型 描述 consumer 是 Object 消费端微服务，具体参考DependencyMicroService。 providers 否 Array of objects 服务端微服务，具体参考DependencyMicroService。

DataCenterInfo 表1 参数说明 参数 是否必选 参数类型 描述 name 是 String 数据中心名称，支持数字、字母，支持使用字符_-.做连接符，长度1-128字节。 region 是 String 数据中心所属区 域名 称，支持数字、字母，支持使用字符_-.做连接符，长度1-128字节。 availableZone 是 String 数据中心所属可用区名称，支持数字、字母，支持使用字符_-.做连接符，长度1-128字节。 父主题： 公共请求参数

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

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

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

响应消息 表3 响应参数 参数 参数类型 描述 list Array of object 构建阶段结构体，请参考表4。 total Integer 构建阶段数量。 page Integer 分页大小，表示一页包含几条记录。 per_page Integer 分页索引，表示从第几页开始。 表4 list 参数 参数类型 描述 job_id String 构建任务标识。 job_name String 构建任务名称，和用户定义的组件名称相同。

URI GET /assembling/v1/jobs?page={page}&per_page={per_page}&job_name={job_name} 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 page 是 Integer 分页索引，表示从第几页开始。 per_page 是 Integer 分页大小，表示一页包含几条记录。 job_name 否 String 构建任务名称，和用户定义的组件名称相同。获取方法，请参考获取应用所有组件。

响应示例 { "buildlog": "Starting...", "next": 25524, "phase_states": "Successful,Successful,Successful,Successful,Successful,Successful", "phases": "Init,Download,PreProcess,Build,Artifact,PostProcess"}

响应消息 表3 响应参数 参数 参数类型 描述 buildlog String 返回的构建日志。 next Integer 返回的日志字符串结束位置。 phase_states String 构建阶段状态。 NotStarted：未开始 Queuing：排队中 Building：构建中 Pushing：正在推送包 Successful：成功 Failed：失败 Timeout：超时 Cancel：取消 Deleted：已删除 phases String 构建阶段名称。 Init：初始化阶段 Download：下载阶段 PreProcess：预处理阶段 Build：构建阶段 Artifact：归档阶段 PostProcess：后置处理阶段

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

响应消息 表3 响应参数 参数 参数类型 描述 list Array of object 构建阶段结构体，请参考表4。 total Integer 构建阶段数量。 表4 list 参数 参数类型 描述 id String 构建阶段标识。 name String 构建阶段名称。 Init：初始化阶段 Download：下载阶段 PreProcess：预处理阶段 Build：构建阶段 Artifact：归档阶段 PostProcess：后置处理阶段 state String 构建阶段状态。 NotStarted：未开始 Queuing：排队中 Building：构建中 Pushing：正在推送包 Successful：成功 Failed：失败 Timeout：超时 Cancel：取消 Deleted：已删除

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

响应示例 { "total": 6, "list": [ { "id": 1627984, "name": "Init", "state": "Successful" }, { "id": 1627985, "name": "Download", "state": "Successful" }, { "id": 1627986, "name": "PreProcess", "state": "Successful" }, { "id": 1627987, "name": "Build", "state": "Successful" }, { "id": 1627988, "name": "Artifact", "state": "Successful" }, { "id": 1627989, "name": "PostProcess", "state": "Successful" } ]}

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK既可以使用永久访问密钥中的AK/SK，也可以使用临时访问密钥中的AK/SK。但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段，字段值为临时访问密钥的security_token。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG....

响应示例 状态码： 200 查询成功。 { "instances": [ { "instanceId": "8540bb8b693c4ad1a7fb6a756c415244", "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "endpoints": [ "rest:127.0.0.1:8080" ], "hostName": "hostNameTest", "status": "UP", "properties": { "engineID": "30c263e5-2eac-4da1-9c72-5abb9ac94550", "engineName": "cse-fkln1-HA" }, "healthCheck": { "mode": "push", "interval": 30, "times": 3 }, "timestamp": "1650545035", "modTimestamp": "1650545035", "version": "1.0.0" } ]}

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-ConsumerId 否 String 微服务消费者的微服务唯一标识。 Authorization 否 String 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MicroServiceInstance objects 实例列表。 表5 MicroServiceInstance 参数 参数类型 描述 instanceId String 实例id，唯一标识。创建实例，instanceId由service-center产生。 serviceId String 微服务唯一标识，创建实例时，以url里面的为准，不用这里的serviceId。 version String 微服务版本号。 hostName String 主机信息。 endpoints Array of strings 访问地址信息。 status String 实例状态：UP、DOWN、STARTING、OUTOFSERVICE。默认值UP。 properties Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 healthCheck HealthCheck object 健康检查信息。 dataCenterInfo DataCenterInfo object 数据中心信息。 timestamp String 实例创建时间戳，自动生成。 modTimestamp String 更新时间。 表6 HealthCheck 参数 参数类型 描述 mode String 心跳模式push/pull。 port Integer 端口。 interval Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。 times Integer 最大尝试请求次数。 表7 DataCenterInfo 参数 参数类型 描述 name String 区域名字。 region String 区域。 availableZone String 可用区。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

URI GET /v4/{project_id}/registry/microservices/{service_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版，请填租户项目id，长度为1~64，获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版，请填固定值：default。 service_id 是 String 微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。 表2 Query参数 参数 是否必选 参数类型 描述 tags 否 String Tag标签过滤，多个时逗号分隔。 正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$。

响应参数 状态码： 200 表11 响应Body参数 参数 参数类型 描述 serviceId String 微服务唯一标识。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

请求示例 创建一个微服务的静态信息，其微服务名为test，微服务版本为1.0.0，rule的类型为白名单，实例的主机信息为instanceTest，访问地址为rest:127.0.0.1:8080。 POST https://{endpoint}/v4/{project_id}/registry/microservices{"service": {"appId": "default","serviceName": "test","version": "1.0.0","description": "this is a test"},"rules": [{"ruleType": "WHITE","attribute": "tag_123","pattern": "aaa"}],"instances": [{"hostName": "instanceTest","endpoints": ["rest:127.0.0.1:8080"]}],"tags": {"test_tag1": "test_tag1","test_tag2": "test_tag2","test_tag3": "test_tag3"}}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 service 是 MicroService object 微服务信息。 rules 否 Array of Rule objects 黑白名单信息。 instances 否 Array of MicroServiceInstance objects 实例信息。 tags 否 Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 表4 MicroService 参数 是否必选 参数类型 描述 serviceId 否 String 微服务唯一标识。字符长度为1~64。正则表达式为^.*$。 environment 否 String 用于区分微服务环境，取值为development、testing、acceptance、production。当配置为development、testing或acceptance时，可以通过批量上传schemas接口新增或者修改已存在的Schema；当配置为production时，则不可以新增或者修改Schema。默认值development。 appId 否 String 应用App唯一标识。字符长度为1~160。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 serviceName 是 String 微服务名称，同一个App要保证唯一。字符长度为1~128。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$。 version 否 String 微服务版本号。字符长度为1~64。 正则表达式为^[0-9]$|^[0-9]+(.[0-9]+)$。 description 否 String 微服务描述信息。字符长度不超过256。 level 否 String 微服务层级：FRONT、MIDDLE、BACK。 registerBy 否 String 微服务注册方式：SDK、PLATFORM、SIDECAR、UNKNOWN。 schemas 否 Array of strings 微服务访问契约内容的外键ID，数组长度最大100个契约。 status 否 String 微服务状态，UP表示上线，DOWN表示下线，默认值UP。 timestamp 否 String 微服务注册时间。 modTimestamp 否 String 最后修改UTC时间。 framework 否 Framework object 开发框架信息。 paths 否 Array of ServicePath objects 服务路由信息。 表5 Framework 参数 是否必选 参数类型 描述 name 否 String 微服务开发框架，默认值为UNKNOWN。 version 否 String 微服务开发框架版本号。 表6 ServicePath 参数 是否必选 参数类型 描述 Path 否 String 路由地址。 Property 否 Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 表7 Rule 参数 是否必选 参数类型 描述 ruleId 否 String 自定义ruleId。 ruleType 否 String rule类型：WHITE或者BLACK。 attribute 否 String 如果是tag_xxx开头，则按Tag过滤attribute属性，否则，则按"serviceId", "AppId", "ServiceName", "Version", "Description", "Level", "Status"过滤。 pattern 否 String 匹配规则，正则表达式，长度1到64。 description 否 String rule描述。 timestamp 否 String 只有获取rule时返回使用，创建rule的时间。 modTimestamp 否 String 更新时间。 表8 MicroServiceInstance 参数 是否必选 参数类型 描述 instanceId 否 String 实例id，唯一标识。创建实例，instanceId由service-center产生。 serviceId 否 String 微服务唯一标识。创建实例时，以url里面的为准，不用这里的serviceId。 version 否 String 微服务版本号。 hostName 是 String 主机信息。 endpoints 是 Array of strings 访问地址信息。 status 否 String 实例状态：UP、DOWN、STARTING、OUTOFSERVICE，默认值UP。 properties 否 Object 微服务扩展属性，可以自定义KEY和相应的Value。长度最小1字节。 healthCheck 否 HealthCheck object 健康检查信息。 dataCenterInfo 否 DataCenterInfo object 数据中心信息。 timestamp 否 String 实例创建时间戳，自动生成。 modTimestamp 否 String 更新时间。 表9 HealthCheck 参数 是否必选 参数类型 描述 mode 是 String 心跳模式： push或者pull。 port 否 Integer 端口。 interval 是 Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。 times 是 Integer 最大尝试请求次数。 表10 DataCenterInfo 参数 是否必选 参数类型 描述 name 是 String 区域名称。 region 是 String 区域。 availableZone 是 String 可用区。

响应示例 状态码： 200 查询成功。 { "instance": { "instanceId": "4994929d6b8044b29462d4f7daa33c4f", "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "endpoints": [ "rest:127.0.0.1:8080" ], "hostName": "hostNameTest", "status": "UP", "properties": { "engineID": "30c263e5-2eac-4da1-9c72-5abb9ac94550", "engineName": "cse-fkln1-HA" }, "healthCheck": { "mode": "push", "interval": 30, "times": 3 }, "timestamp": "1650545270", "modTimestamp": "1650545270", "version": "1.0.0" }}

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-consumerId 否 String 微服务消费者的微服务唯一标识。 Authorization 否 String 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。