华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 aggregator_id 是 String 资源聚合器ID 最小长度:1 最大长度:256 account_id 否 String 源帐号ID 最小长度:1 最大长度:36 group_by_key 否 String 用于对资源计数进行分组的键(DOMAIN)。 最小长度:1 最大长度:16
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 aggregator_name 是 String 资源聚合器名称。 最小长度:1 最大长度:64 aggregator_type 是 String 聚合器类型(ACCOUNT | ORGANIZATION)。 account_aggregation_sources 否 AccountAggregationSource object 聚合数据的源帐号。 表4 AccountAggregationSource 参数 是否必选 参数类型 描述 domain_ids 否 Array of strings 帐号列表。 最小长度:0 最大长度:36
  • 请求示例 创建资源聚合器。 PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators{ "aggregator_name" : "example_aggregator", "aggregator_type" : "ACCOUNT", "account_aggregation_sources" : { "domain_ids" : [ "3fd23817bd85480e8dc4f520075de348" ] }}
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 aggregator_name String 资源聚合器名称。 aggregator_id String 资源聚合器ID。 aggregator_urn String 资源聚合器标识符。 aggregator_type String 聚合器类型。 account_aggregation_sources AccountAggregationSource object 聚合数据的源帐号。 updated_at String 资源聚合器更新时间。 created_at String 资源聚合器创建时间。 表6 AccountAggregationSource 参数 参数类型 描述 domain_ids Array of strings 帐号列表。 最小长度:0 最大长度:36 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • 响应示例 状态码: 200 操作成功。 { "aggregator_name" : "example_aggregator", "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f", "aggregator_urn" : "rms::e74e043fab784a45ad88f5ef6a4bcffc:aggregationAggregator:7ca3447830bd49c9b630a99680eaf90f", "aggregator_type" : "ACCOUNT", "account_aggregation_sources" : { "domain_ids" : [ "3fd23817bd85480e8dc4f520075de348" ] }, "updated_at" : "2020-01-18T02:49:12.465Z", "created_at" : "2020-01-18T02:49:12.465Z"}
  • 响应示例 状态码: 200 操作成功。 { "aggregator_name" : "example_aggregator", "aggregator_id" : "2f0cc4991bac4940ae20a3630818589e", "aggregator_urn" : "rms::e74e043fab784a45ad88f5ef6a4bcffc:aggregationAggregator:2f0cc4991bac4940ae20a3630818589e", "aggregator_type" : "ACCOUNT", "account_aggregation_sources" : { "domain_ids" : [ "3fd23817bd85480e8dc4f520075de348" ] }, "updated_at" : "2020-01-18T02:49:12.465Z", "created_at" : "2020-01-18T02:49:12.465Z"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 aggregator_name String 资源聚合器名称。 aggregator_id String 资源聚合器ID。 aggregator_urn String 资源聚合器标识符。 aggregator_type String 聚合器类型。 account_aggregation_sources AccountAggregationSource object 聚合数据的源帐号。 updated_at String 资源聚合器更新时间。 created_at String 资源聚合器创建时间。 表4 AccountAggregationSource 参数 参数类型 描述 domain_ids Array of strings 帐号列表。 最小长度:0 最大长度:36 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • 响应示例 状态码: 200 操作成功。 { "value" : [ { "type" : "aad.intances", "schema" : { "expireTime" : "int", "ispSpec" : "string", "specType" : "int", "basicBandwidth" : "int", "elasticBandwidth" : "int", "serviceBandwidth" : "int" } } ], "page_info" : { "current_count" : 1, "next_marker" : null }}
  • URI GET /v1/resource-manager/domains/{domain_id}/schemas 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 最大的返回数量。 最小值:1 最大值:200 缺省值:200 marker 否 String 分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。 最小长度:4 最大长度:400
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 value Array of ResourceSchemaResponse objects schemas接口。 page_info PageInfo object 分页对象。 表5 ResourceSchemaResponse 参数 参数类型 描述 type String 资源类型。 schema Object schema 内容。 表6 PageInfo 参数 参数类型 描述 current_count Integer 当前页的资源数量。 最小值:0 最大值:200 next_marker String 下一页的marker。 最小长度:4 最大长度:400 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 资源总数。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • URI GET /v1/resource-manager/domains/{domain_id}/all-resources/count 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 资源ID。 最大长度:256 name 否 String 资源名称。 最大长度:64 type 否 Array 资源类型(provider.type)。 region_id 否 Array 区域ID列表。 ep_id 否 Array 企业项目ID列表。 project_id 否 Array 项目ID。 tags 否 Array 标签列表。
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • 响应示例 状态码: 200 操作成功。 [ { "provider" : "obs", "types" : [ { "type" : "buckets", "regions" : [ { "region_id" : "regionid1", "count" : 5 } ] } ]}, { "provider" : "ecs", "types" : [ { "type" : "cloudservers", "regions" : [ { "region_id" : "regionid2", "count" : 1 } ] } ]} ]
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of ResourceSummaryResponseItem objects 资源概要信息列表。 表5 ResourceSummaryResponseItem 参数 参数类型 描述 provider String 云服务名称。 types Array of types objects 资源类型列表。 表6 types 参数 参数类型 描述 type String 资源类型名称。 regions Array of regions objects 区域列表。 表7 regions 参数 参数类型 描述 region_id String 区域ID。 count Long 该资源类型在当前区域的数量。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • URI GET /v1/resource-manager/domains/{domain_id}/all-resources/summary 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 资源名称。 最大长度:64 type 否 Array 资源类型(provider.type)。 region_id 否 Array 区域ID列表。 ep_id 否 Array 企业项目ID列表。 project_id 否 Array 项目ID。 tags 否 Array 标签列表。
  • 响应示例 状态码: 200 操作成功。 { "agency_name" : "rms_tracker_agency", "channel" : { "obs" : { "bucket_name" : "rmtest", "region_id" : "regionid1" }, "smn" : { "project_id" : "059b5e0a2500d5552fa1c00adada8c06", "region_id" : "regionid1", "topic_urn" : "urn:smn:regionid1:059b5e0a2500d5552fa1c00adada8c06:agencytest" } }, "selector" : { "all_supported" : true, "resource_types" : [ ] }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 channel ChannelConfigBody object tracker通道配置。 selector SelectorConfigBody object tracker选择器。 agency_name String IAM 委托名称。 表4 ChannelConfigBody 参数 参数类型 描述 smn Tracker SMN ChannelConfigBody object SMN通道设置对象。跨帐号授予SMN主题发送通知的权限请参考《用户指南- 资源记录器- 开启/配置/修改资源记录器》中的“跨帐号授权”内容。 obs TrackerOBSChannelConfigBody object OBS设置对象。跨帐号授予OBS桶转储文件的权限请参考《用户指南- 资源记录器- 开启/配置/修改资源记录器》中的“跨帐号授权”内容。 表5 TrackerSMNChannelConfigBody 参数 参数类型 描述 region_id String 区域id。 project_id String 项目id。 topic_urn String SMN主题urn。 表6 TrackerOBSChannelConfigBody 参数 参数类型 描述 bucket_name String OBS桶名称。 region_id String 区域id。 表7 SelectorConfigBody 参数 参数类型 描述 all_supported Boolean 是否选择所有支持的资源。 resource_types Array of strings 资源类型列表。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • 请求示例 创建资源记录器,并开启消息推送与转储。 PUT /v1/resource-manager/domains/{domain_id}/tracker-config{ "channel" : { "smn" : { "region_id" : "regionid1", "project_id" : "39c2af998c334ed6bcbb75b27318f7b5", "topic_urn" : "urn:smn:regionid1:39c2af998c334ed6bcbb75b27318f7b5:resource-manager-test" }, "obs" : { "bucket_name" : "config-snapshot", "region_id" : "regionid1" } }, "selector" : { "all_supported" : true, "resource_types" : [ ] }, "agency_name" : "rms_tracker_agency"}
  • 响应参数 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 调用者token。 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表3 请求Body参数 参数 是否必选 参数类型 描述 channel 是 ChannelConfigBody object tracker通道配置。 selector 是 SelectorConfigBody object tracker选择器。 agency_name 是 String IAM委托名称。 表4 ChannelConfigBody 参数 是否必选 参数类型 描述 smn 否 TrackerSMNChannelConfigBody object SMN通道设置对象。跨帐号授予SMN主题发送通知的权限请参考《用户指南- 资源记录器- 开启/配置/修改资源记录器》中的“跨帐号授权”内容。 obs 否 TrackerOBSChannelConfigBody object OBS设置对象。跨帐号授予OBS桶转储文件的权限请参考《用户指南- 资源记录器- 开启/配置/修改资源记录器》中的“跨帐号授权”内容。 表5 TrackerSMNChannelConfigBody 参数 是否必选 参数类型 描述 region_id 是 String 区域id。 project_id 是 String 项目id。 topic_urn 是 String SMN主题urn。 表6 TrackerOBSChannelConfigBody 参数 是否必选 参数类型 描述 bucket_name 是 String OBS桶名称。 region_id 是 String 区域id。 表7 SelectorConfigBody 参数 是否必选 参数类型 描述 all_supported 是 Boolean 是否选择所有支持的资源。 resource_types 是 Array of strings 资源类型列表。
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 aggregate_policy_assignments Array of AggregatePolicyAssignments objects 聚合合规规则的列表。 page_info PageInfo object 分页对象。 表7 AggregatePolicyAssignments 参数 参数类型 描述 policy_assignment_id String 合规规则ID policy_assignment_name String 合规规则名称 compliance Compliance object 合规规则合规性 account_id String 源帐号ID。 表8 Compliance 参数 参数类型 描述 compliance_state String 合规结果。 resource_details PolicyComplianceSummaryUnit object 规则总结详情。 表9 PolicyComplianceSummaryUnit 参数 参数类型 描述 compliant_count Integer 合规数量。 non_compliant_count Integer 不合规数量。 表10 PageInfo 参数 参数类型 描述 current_count Integer 当前页的资源数量。 最小值:0 最大值:200 next_marker String 下一页的marker。 最小长度:4 最大长度:400 状态码: 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 403 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。 状态码: 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息内容。
  • 响应示例 状态码: 200 操作成功。 { "aggregate_policy_assignments" : [ { "policy_assignment_id" : "62bdbe5913c6836025b1e3af", "policy_assignment_name" : "volumes-encrypted-check", "compliance" : { "compliance_state" : "Compliant", "resource_details" : { "compliant_count" : 18, "non_compliant_count" : 0 } }, "account_id" : "789d4ac10eda4d9b8e090f5c2b1e4459" }, { "policy_assignment_id" : "631ea13f57e0427679a1794d", "policy_assignment_name" : "cts-lts-enable", "compliance" : { "compliance_state" : "NonCompliant", "resource_details" : { "compliant_count" : 28, "non_compliant_count" : 2 } }, "account_id" : "83240c3f2ec1465aaa0124c87810ce65" } ], "page_info" : { "current_count" : 2, "next_marker" : "CAESIDdjYTM0NDc4MzBiZDQ5YzliNjMwYTk5NjgwZWFmOTBmGgQ-0aw3" }}
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 最小长度:0 最大长度:2048 表4 请求Body参数 参数 是否必选 参数类型 描述 aggregator_id 是 String 资源聚合器ID 最小长度:1 最大长度:256 filter 否 AggregatePolicyAssignmentsFilters object 聚合合规规则过滤器。 表5 AggregatePolicyAssignmentsFilters 参数 是否必选 参数类型 描述 account_id 否 String 源帐号ID。 最小长度:1 最大长度:36 compliance_state 否 String 合规结果。 policy_assignment_name 否 String 合规规则名称 最大长度:64
  • URI POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignments/compliance 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 帐号ID。 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 最大的返回数量。 最小值:1 最大值:200 缺省值:200 marker 否 String 分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。 最小长度:4 最大长度:400
  • 响应示例 状态码: 200 操作成功。 { "id" : "5fb76a240f2daf0b9662a04d", "name" : "volume-inuse-check", "description" : "云硬盘未挂载给任何云服务器,视为“不合规”。", "policy_filter" : { "region_id" : null, "resource_provider" : "evs", "resource_type" : "volumes", "resource_id" : null, "tag_key" : null, "tag_value" : null }, "state" : "Enabled", "created" : "2020-11-20T07:03:00", "updated" : "2020-11-20T07:03:00", "policy_definition_id" : "5fa36558aa1e6afc05a3d0a7", "parameters" : { }}
  • 支持的授权项 策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 Config支持的自定义策略授权项如下所示: 资源清单,包含资源接口对应的授权项,如查看资源历史、列举指定类型的资源等接口。 资源记录器,包含资源记录器接口对应的授权项,如查询资源记录器、创建资源记录器、删除资源记录器等接口。 资源合规,包含资源合规接口对应的授权项,如创建合规规则、更新合规规则、删除合规规则等接口。 高级查询,包含高级查询接口对应的授权项,如运行ResourceQL查询、创建查询语句、列举查询语句等接口。 资源聚合器,包含资源聚合器接口对应的授权项,如创建资源聚合器、更新资源聚合器、删除资源聚合器等接口。 “√”表示支持,“x”表示暂不支持。
  • 资源记录器 权限 对应API接口 授权项 IAM项目 企业项目 查询资源记录器 GET /v1/resource-manager/domains/{domain_id}/tracker-config rms:trackerConfig:get √ 不涉及 创建或更新资源记录器 PUT /v1/resource-manager/domains/{domain_id}/tracker-config rms:trackerConfig:put √ 不涉及 删除资源记录器 DELETE /v1/resource-manager/domains/{domain_id}/tracker-config rms:trackerConfig:delete √ 不涉及 父主题: 权限和授权项
  • 资源清单 权限 对应API接口 授权项 IAM项目 企业项目 查看资源历史 GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/history rms:resources:getHistory √ 不涉及 查询资源关系 GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}/relations rms:resources:getRelation √ 不涉及 列举指定类型的资源 GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources rms:resources:list √ 不涉及 查询单个资源 GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources/{resource_id} rms:resources:get √ 不涉及 列举资源概要 GET /v1/resource-manager/domains/{domain_id}/all-resources/summary rms:resources:list √ 不涉及 查询资源数量 GET /v1/resource-manager/domains/{domain_id}/all-resources/count rms:resources:list √ 不涉及 列举所有资源 GET /v1/resource-manager/domains/{domain_id}/all-resources rms:resources:list √ 不涉及 列举资源标签 GET /v1/resource-manager/domains/{domain_id}/all-resources/tags rms:resources:list √ 不涉及 查询帐号下的单个资源 GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id} rms:resources:get √ 不涉及 父主题: 权限和授权项
  • API概览 表1 配置审计 服务接口列表 类型 说明 资源查询 包括查询资源、查询资源标签、查询资源数量和概要、列举云服务等接口。 资源记录器 包括资源记录器的增、删、改、查接口。 资源关系 查询资源关系和详情接口。 资源历史 查询资源历史接口。 合规性 包括列举和查询合规策略,合规规则的增、删、改、查,运行合规评估,获取和更新合规结果,组织合规规则的增、删、改、查等接口。 区域管理 查询用户可见的区域接口。 高级查询 包括运行高级查询,高级查询的增、删、改、查等接口。 资源聚合器 包括资源聚合器的增、删、改、查,资源聚合器授权的增、删、改、查,查询资源聚合器中的资源计数,以及对资源聚合器运行高级查询等接口。
共100000条