分组-华为云

云监控服务 CES-查询资源分组下指定服务类别特定维度的资源列表:URI

URI GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 group_id 是 String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串最小长度：2 最大长度：24 service 是 String 服务类别，如SYS.ECS 最小长度：3 最大长度：32 表2 Query参数参数是否必选参数类型描述 dim_name 否 String 资源维度信息，多个维度按字母序使用逗号分割最小长度：1 最大长度：131 limit 否 String 分页查询时每页的条目数，取值[1,100]，默认值为100 最小长度：1 最大长度：100 offset 否 Integer 分页查询时查询的起始位置，表示从第几条数据开始，默认为0 最小值：0 最大值：10000 status 否 String 按状态信息进行过滤，取值只能为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未设置告警规则的资源）枚举值： health unhealthy no_alarm_rule dim_value 否 String 资源维度值，不支持模糊匹配，但是多维度资源可以只指定一个维度值最小长度：1 最大长度：1027 tag 否 String 资源的标签信息，格式："[key]":"[value]"，样例参考："ssss":"1111" 最小长度：0 最大长度：500 extend_relation_id 否 String 企业项目ID 最小长度：0 最大长度：128

云监控服务 CES 资源分组关联资源

云监控服务 CES-查询资源分组下指定服务类别特定维度的资源列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 count Integer 资源总数最小值：0 最大值：10000 resources Array of GetResourceGroupResources objects 资源分组资源列表数组长度：0 - 100 表5 GetResourceGroupResources 参数参数类型描述 status String 资源健康状态，取值为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未关联告警规则）枚举值： health unhealthy no_alarm_rule dimensions Array of Dimension objects 资源的维度信息数组长度：1 - 4 表6 Dimension 参数参数类型描述 name String 资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务指标维度”。正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value String 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。正则匹配：^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ 状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表8 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表9 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 404 表10 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表11 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

云监控服务 CES 资源分组关联资源

云监控服务 CES-查询资源分组下指定服务类别特定维度的资源列表:响应示例

响应示例状态码： 200 OK { "count" : 1000, "resources" : [ { "status" : "health", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ] }

云监控服务 CES 资源分组关联资源

云监控服务 CES-查询指定资源分组详情:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 group_name String 资源分组的名称正则匹配：^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ group_id String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串最小长度：2 最大长度：24 create_time String 资源分组的创建时间 enterprise_project_id String 资源分组归属企业项目ID 正则匹配：^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ type String 资源分组添加资源方式，取值只能为EPS（同步企业项目）,TAG（标签动态匹配）,Manual（手动添加）枚举值： EPS TAG Manual association_ep_ids Array of strings 该资源分组内包含的资源来源的企业项目ID，type为EPS时必传数组长度：1 - 1 tags Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时该字段不为空数组长度：1 - 10 表4 ResourceGroupTagRelation 参数参数类型描述 key String 键最小长度：1 最大长度：36 value String 值最小长度：1 最大长度：42 状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表6 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表7 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 404 表8 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表9 响应Body参数参数参数类型描述 error_code String 请求异常内部业务状态码最小长度：0 最大长度：256 error_msg String 请求异常信息最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

云监控服务 CES 资源分组

云监控服务 CES-查询指定资源分组详情:响应示例

响应示例状态码： 200 OK { "group_name" : "band", "type" : "TAG", "tags" : [ { "key" : "Resource", "value" : "VPC" }, { "key" : "Usage", "value" : "Tmp" } ], "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0" }

云监控服务 CES 资源分组

云监控服务 CES-更新资源分组:请求消息

请求消息请求参数表2 请求参数名称类型是否必选说明 group_name String 是资源分组的名称，长度为1-128，只能包含0-9/a-z/A-Z/_/-或汉字。如：ResourceGroup-Test01。 resources Array of objects 是创建的资源分组选择一个或者多个资源。详细参数说明请参见表3。表3 resources字段数据结构说明名称参数类型是否必选说明 namespace String 是资源命名空间，如弹性云服务器的资源命名空间为：SYS.ECS，各服务命名空间可查看支持监控的服务列表。 dimensions Arrays of objects 是一个或者多个资源维度。详细参数说明请参见表4。表4 dimensions字段数据结构说明名称参数类型是否必选说明 name String 是资源维度，例如弹性云服务器维度为：instance_id，各资源的维度可查看支持监控的服务列表。 value String 是资源维度值，为资源的实例ID。如：4270ff17-aba3-4138-89fa-820594c39755。请求示例： { "group_name": "Resource-Group-Test01", "resources": [ { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "063a83da-a2b5-4630-ab6b-9b4fcfc261ea" } ] }, { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "518ace88-abde-46bf-829b-0d1f0f2fb2e9" } ] }, { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "675006b5-477a-4aab-948c-0aa467de9c68" } ] } ] }

云监控服务 CES 资源分组管理

云监控服务 CES-更新资源分组:返回值

返回值正常 204 异常返回值说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息，或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成，服务异常。 503 Service Unavailable 系统暂时不可用，请求受限。

云监控服务 CES 资源分组管理

云监控服务 CES-更新资源分组:URI

URI PUT /V1.0/{project_id}/resource-groups/{group_id} 参数说明表1 参数说明名称类型是否必选说明 project_id String 是项目ID。获取方式请参见获取项目ID。 group_id String 是资源分组ID。请求样例： PUT https://{云监控的endpoint}/V1.0/{project_id}/resource-groups/{group_id}

云监控服务 CES 资源分组管理

API网关 APIG-修改分组下指定错误类型的自定义响应:URI

URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}/{response_type} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 response_id 是 String 响应编号 response_type 是 String 错误类型 AUTH_FAILURE: 认证失败，IAM或APP认证校验失败 AUTH_HEADER_MISSING: 认证身份来源信息缺失 AUTHORIZER_FAILURE: 自定义认证方返回认证失败 AUTHORIZER_CONF_FAILURE:自定义认证方异常，通信失败、返回异常响应等错误 AUTHORIZER_IDENTITIES_FAILURE: 前端自定义认证的身份来源信息缺失或不合法错误 BACKEND_UNAVAILABLE: 后端不可用，网络不可达错误 BACKEND_TIMEOUT: 后端超时，与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED: 使用的凭据未被授权访问该API ACCESS_DENIED: 拒绝访问，如触发配置的访问控制策略、或异常攻击检测拦截 NOT_FOUND: 未匹配到API错误 REQUEST_PARAMETERS_FAILURE: 请求参数校验失败、不支持的HTTP方法 DEFAULT_4XX: 其它4XX类错误 DEFAULT_5XX: 其它5XX类错误 THIRD_AUTH_FAILURE: 第三方认证方返回认证失败 THIRD_AUTH_IDENTITIES_FAILURE: 第三方认证的身份来源信息缺失或不合法错误 THIRD_AUTH_CONF_FAILURE: 第三方认证方异常，通信失败、返回异常响应等错误 ORCHESTRATION_PARAMETER_NOT_FOUND: 参数编排失败，请求中没有待编排的入参 ORCHESTRATION_FAILURE: 参数编排失败，没有编排规则匹配成功枚举值： AUTH_FAILURE AUTH_HEADER_MISSING AUTHORIZER_FAILURE AUTHORIZER_CONF_FAILURE AUTHORIZER_IDENTITIES_FAILURE BACKEND_UNAVAILABLE BACKEND_TIMEOUT THROTTLED UNAUTHORIZED ACCESS_DENIED NOT_FOUND REQUEST_PARAMETERS_FAILURE DEFAULT_4XX DEFAULT_5XX THIRD_AUTH_FAILURE THIRD_AUTH_IDENTITIES_FAILURE THIRD_AUTH_CONF_FAILURE ORCHESTRATION_PARAMETER_NOT_FOUND ORCHESTRATION_FAILURE

API网关 APIG 专享版-分组自定义响应管理

API网关 APIG-修改分组下指定错误类型的自定义响应:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 status 否 Integer 响应的HTTP状态码。范围为200-599，但不允许为444。 body 否 String 响应的Body模板 headers 否 Array of ResponseInfoHeader objects 自定义的响应头数组长度：0 - 10 表4 ResponseInfoHeader 参数是否必选参数类型描述 key 否 String 分组自定义响应的响应头的key，支持英文字母、数字和中划线，长度为1到128位 value 否 String 分组自定义响应的响应头的value，为长度为1到1024位的字符串最小长度：1 最大长度：1024

API网关 APIG 专享版-分组自定义响应管理

API网关 APIG-修改分组下指定错误类型的自定义响应:响应示例

响应示例状态码： 200 OK { "ACCESS_DENIED" : { "body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}", "default" : true, "status" : 403 } } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:group_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

API网关 APIG 专享版-分组自定义响应管理

API网关 APIG-绑定域名:操作场景

操作场景开放API前，您需要为API分组绑定一个或多个独立域名，API网关通过独立域名定位到此分组。共享版中，不同分组下不能绑定相同的独立域名。在绑定域名前，您需要理解以下2个概念：子域名：API分组创建后，系统为分组自动分配一个内部测试用的子域名，此子域名唯一且不可更改，每天最多可以访问1000次。独立域名：您自定义的域名，最多可以添加5个独立域名，不限访问次数。API调用者通过访问独立域名来调用您开放的API。

API网关 APIG API分组管理

API网关 APIG-绑定域名:前提条件

前提条件已有独立域名。可通过域名注册服务申请新的域名。公网独立域名需要备案，未备案的独立域名无法被访问。备案时长需几个工作日，建议您提前进行备案。共享版：已将独立域名CNAME解析到分组的子域名上，具体方法请参见增加CNAME类型记录集。如果API分组中的API支持HTTPS请求协议，那么在独立域名中需要添加SSL证书，请您提前准备SSL证书。此证书不支持导入，您需要填写证书的名称、内容和密钥。

API网关 APIG API分组管理

API网关 APIG-查询分组详情:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 id String 编号 name String API分组名称 status Integer 状态 1：有效枚举值： 1 sl_domain String 系统默认分配的子域名 register_time String 创建时间 update_time String 最近修改时间 on_sell_status Integer 是否已上架云商店： 1：已上架 2：未上架 3：审核中 url_domains Array of UrlDomain objects 分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问，true表示可以访问，false表示禁止访问缺省值：true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置暂不支持 time_interval Integer 流控时长暂不支持 time_unit String 流控的时间单位暂不支持 is_default Integer 是否为默认分组 version String 分组版本 V1：全局分组 V2：应用级分组暂不支持，默认为V1 roma_app_id String 分组归属的集成应用编号。分组版本V2时必填。暂不支持 roma_app_name String 分组归属的集成应用名称暂不支持表4 UrlDomain 参数参数类型描述 id String 域名编号 domain String 访问域名 cname_status Integer 域名cname状态： 1：未解析 2：解析中 3：解析成功 4：解析失败 ssl_id String SSL证书编号 ssl_name String SSL证书名称 min_ssl_version String 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 缺省值：TLSv1.1 枚举值： TLSv1.1 TLSv1.2 verified_client_certificate_enabled Boolean 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。缺省值：false is_has_trusted_root_ca Boolean 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。缺省值：false 状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

API网关 APIG 专享版-API分组管理

API网关 APIG-查询分组详情:响应示例

响应示例状态码： 200 OK { "update_time" : "2020-07-31T06:55:55Z", "name" : "api_group_001", "on_sell_status" : 2, "remark" : "API group 1", "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ], "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "register_time" : "2020-07-31T06:55:55Z", "status" : 1, "is_default" : 2, "sl_domain_access_enabled" : true } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

API网关 APIG 专享版-API分组管理

云服务器内容精选

分组

7*24

备案

专业服务

退订

建议反馈

售前咨询热线