huawei-cloud-api-definitions-CBR 0.1.20251031

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"OrganizationPoliciesListResp":{"description":"组织策略列表响应体","properties":{"count":{"description":"组织策略数量","format":"int32","type":"integer"},"limit":{"description":"每页显示的条目数量","format":"int32","type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询","format":"int32","type":"integer"},"policies":{"description":"组织策略列表","items":{"$ref":"#/definitions/OrganizationPolicy","description":"组织策略成员信息"},"type":"array"}},"required":["count","policies"]},"OrganizationPolicy":{"description":"组织策略","properties":{"description":{"description":"组织策略描述","maxLength":255,"minLength":0,"type":"string"},"domain_id":{"description":"组织策略所属账号ID","type":"string"},"domain_name":{"description":"组织策略所属账号","type":"string"},"effective_scope":{"description":"组织策略生效范围","maxLength":255,"minLength":0,"type":"string"},"id":{"description":"组织策略ID","type":"string"},"name":{"description":"组织策略名称","maxLength":64,"minLength":1,"type":"string"},"operation_type":{"description":"组织策略类型\n- backup: 备份\n-  replication: 复制","enum":["backup","replication"],"type":"string"},"policy_enabled":{"description":"策略是否开启","type":"boolean"},"policy_name":{"description":"策略名称","maxLength":64,"minLength":1,"type":"string"},"policy_operation_definition":{"$ref":"#/definitions/PolicyoODCreate","description":"策略定义,备份和复制里面的具体字段各不相同,和策略的保持一致"},"policy_trigger":{"$ref":"#/definitions/PolicyTriggerReq","description":"策略执行时间规则"},"status":{"description":"组织策略状态","type":"string"}},"required":["domain_id","id","name","operation_type","policy_enabled","policy_name","policy_operation_definition","policy_trigger","status"]},"PolicyTriggerPropertiesReq":{"description":"","properties":{"pattern":{"description":"调度规则。限制24条规则。调度器的调度规则,可参照iCalendar RFC 2445规范中的事件规则,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且间隔不能小于一小时,一天最大24个时间点。例如,周一到周天,每天UTC时间的14:00调度,其规则为:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。例如:某个地区的时间为 UTC+8,如果在该地区每天14:00调度,则在14点基础上减8,其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00'。","items":{"description":"","type":"string"},"type":"array","x-open-region-cloud":"hc,hk,otc,obc,tlf,ctc,hcso,sbc,g42,tm,cmcc,dt_test,hcso_dt,mix,hk_sbc,hws_ocb,fcs,fcs_dt,hcso_g42_b"}},"required":["pattern"]},"PolicyTriggerReq":{"properties":{"properties":{"$ref":"#/definitions/PolicyTriggerPropertiesReq","description":"调度器属性"}},"required":["properties"]},"PolicyoODCreate":{"properties":{"day_backups":{"description":"保留日备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。","format":"int32","maximum":100,"minimum":0,"type":"integer","x-huawei-extraAnnotation":""},"destination_project_id":{"description":"复制的目标项目ID,仅在跨区域复制时才会使用并且必须指定。","type":"string","x-open-region-cloud":"hc,hk"},"destination_region":{"description":"复制的目标区域,仅在跨区域复制时才会使用并且必须指定。长度限制:0- 255,只能由字母、数字、“_”、“-”组成","pattern":"^[a-zA-Z0-9._\\-]*$","type":"string","x-open-region-cloud":"hc,hk"},"enable_acceleration":{"description":"跨区域复制时,是否启用加速从而缩减复制的时间,如果不指定,默认不启用加速。","type":"boolean","x-open-region-cloud":"hc,hk"},"full_backup_interval":{"description":"每间隔多少次执行一次全量备份,当取值为 -1 时,不执行全量备份。 \n最小值:-1 \n最大值:100","format":"int32","maximum":100,"minimum":-1,"type":"integer"},"max_backups":{"default":-1,"description":"单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。","format":"int32","maximum":99999,"minimum":1,"type":"integer","x-huawei-extraAnnotation":""},"month_backups":{"description":"保留月备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。","format":"int32","maximum":100,"minimum":0,"type":"integer","x-huawei-extraAnnotation":""},"retention_duration_days":{"default":-1,"description":"备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空,备份会永久保留。","format":"int32","maximum":99999,"minimum":1,"type":"integer"},"timezone":{"description":"用户所在时区,格式形如UTC+08:00, 若选择年备,月备,周备,日备中任一参数,则该参数不能为空。","pattern":"'UTC([+-]{1,1}[0-9]{2,2}[:]{1,1}[0-9]{2,2})'","type":"string","x-huawei-extraAnnotation":""},"week_backups":{"description":"保留周备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。","format":"int32","type":"integer","x-huawei-extraAnnotation":""},"year_backups":{"description":"保留年备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。","format":"int32","maximum":100,"minimum":0,"type":"integer","x-huawei-extraAnnotation":""}}}},"description":null,"group_id":"11b1e4b30d524dacb6891902e04115dd","host":"cbr.cn-north-4.myhuaweicloud.com","id":"33a6ce54d0e34a8fa76bf32b3533042c","info_version":"v1","method":"get","name":"ListOrganizationPolicies","parameters":{},"paths":{"/v3/{project_id}/organization-policies":{"get":{"description":"查询组织策略列表","operationId":"ListOrganizationPolicies","parameters":[{"description":"项目ID","in":"path","name":"project_id","required":true,"type":"string","x-open-region-cloud":"","x-order":1},{"description":"组织策略类型","in":"query","name":"operation_type","required":true,"type":"string","x-open-region-cloud":"","x-order":2},{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-open-region-cloud":"","x-order":3},{"description":"每页显示的条目数量,正整数","format":"int32","in":"query","name":"limit","required":false,"type":"integer","x-order":4},{"description":"偏移值,正整数","format":"int32","in":"query","name":"offset","required":false,"type":"integer","x-order":5}],"responses":{"200":{"description":"OK","examples":{"application/json":{"count":4,"limit":1000,"offset":0,"policies":[{"domain_id":"0ae13f008700d53f0fb4c01200e79660","id":"5f5dd325-d7d1-4693-9d97-db37ecb91696","name":"organization-policies_create_test","operation_type":"backup","policy_enabled":false,"policy_name":"policy_create_test","policy_operation_definition":{"day_backups":0,"full_backup_interval":-1,"max_backups":-1,"month_backups":0,"retention_duration_days":30,"timezone":"UTC+08:00","week_backups":0,"year_backups":0},"policy_trigger":{"properties":{"pattern":["FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"]}},"status":"syncing"}]}},"schema":{"$ref":"#/definitions/OrganizationPoliciesListResp"}}},"summary":"查询组织策略列表","tags":["组织策略"],"x-apiexplorer-hide":"false","x-first-open-time":"","x-is-registered":"Y","x-name":"查询组织策略列表","x-open-region-cloud":"hc,hk","x-order":2,"x-publishpath":"","x-request-examples-1":"GET https://{endpoint}/v3/{project_id}/organization-policies?operation_type=backup","x-request-examples-description-1":"查询组织策略列表。","x-request-examples-text-1":"GET https://{endpoint}/v3/{project_id}/organization-policies?operation_type=backup","x-request-examples-url-1":"GET https://{endpoint}/v3/{project_id}/organization-policies?operation_type=backup","x-scope":"Commercial","x-support-sdk":"Y"}}},"product_short":"CBR","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询组织策略列表","tags":"组织策略","uri":null,"version":"2.0"}