huawei-cloud-api-definitions-DC 0.1.20250117

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":{"parameters":{"AuthToken":{"description":"用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"schema":{"maxLength":10240,"minLength":0,"type":"string"}},"Fields":{"description":"显示字段列表","in":"query","name":"fields","required":false,"schema":{"items":{"maxLength":100,"minLength":0,"type":"string"},"maxItems":5,"minItems":1,"type":"array"}},"Limit":{"description":"每页返回的个数。\n取值范围:1~2000。","example":10,"in":"query","name":"limit","schema":{"default":2000,"format":"int32","maximum":2000,"minimum":1,"type":"integer"}},"Marker":{"description":"上一页最后一条资源记录的ID,为空时为查询第一页。\n使用说明:必须与limit一起使用。","example":"7f7f738f-453c-40b1-be26-28e7b9e390c1","in":"query","name":"marker","schema":{"maxLength":36,"minLength":0,"type":"string"}},"ProjectId":{"description":"租户项目ID","in":"path","name":"project_id","required":true,"schema":{"maxLength":36,"minLength":0,"pattern":"[a-fA-F0-9]{32}","type":"string"}},"QueryByResourceId":{"description":"通过RESOURCE-ID过虑倒换测试记录信息","explode":true,"in":"query","name":"resource_id","schema":{"description":"资源ID","items":{"type":"string"},"type":"array"},"style":"form"},"SortDir":{"description":"返回结果按照升序(asc)或降序(desc)排列,默认为asc","in":"query","name":"sort_dir","required":false,"schema":{"items":{"enum":["asc","desc"],"type":"string"},"type":"array"}},"SortKey":{"description":"排序字段。","example":["id"],"in":"query","name":"sort_key","required":false,"schema":{"default":"id","maxLength":36,"minLength":0,"type":"string"}}},"schemas":{"ListSwitchoverTestRecordsResponseBody":{"description":"","properties":{"page_info":{"$ref":"#/components/schemas/PageInfo"},"request_id":{"description":"操作请求ID","type":"string"},"switchover_test_records":{"description":"倒换测试记录信息列表","items":{"$ref":"#/components/schemas/SwitchoverTestRecord"},"type":"array"}},"required":["page_info","request_id","switchover_test_records"],"type":"object"},"PageInfo":{"description":"分页查询页的信息","properties":{"current_count":{"description":"当前列表中资源数量","format":"int32","maximum":2000,"minimum":0,"type":"integer"},"next_marker":{"description":"下一页的marker,值为资源的uuid,为空时表示最后一页","maxLength":36,"minLength":0,"type":"string"},"previous_marker":{"description":"上一页的marker,值为资源的uuid","maxLength":36,"minLength":0,"type":"string"}},"required":["current_count","previous_marker"],"type":"object"},"SwitchoverTestRecord":{"description":"倒换测试记录信息","properties":{"end_time":{"description":"倒换测试操作的结束时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2023-10-09T18:41:23.000Z","format":"date-time","type":"string"},"id":{"description":"倒换测试记录的唯一标识","type":"string"},"operate_status":{"description":"倒换测试状态记录\nSTARTING: 初始状态\nINPROGRESS: 配置下发中\nCOMPLETE: 配置下发完成\nERROR: 配置下发失败","enum":["STARTING","INPROGRESS","COMPLETE","ERROR"],"example":"STARTING","type":"string"},"operation":{"description":"shutdown, undo_shutdown表示倒换测试操作类型","enum":["shutdown","undo_shutdown"],"maxLength":128,"minLength":0,"type":"string"},"resource_id":{"description":"倒换测试的资源对象ID","pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}","type":"string"},"resource_type":{"default":"virtual_interface","description":"倒换测试的资源对象类型","enum":["virtual_interface"],"maxLength":128,"minLength":0,"type":"string"},"start_time":{"description":"倒换测试操作的开始时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2023-10-09T18:41:23.000Z","format":"date-time","type":"string"},"tenant_id":{"description":"租户ID","example":"de58f033eb664102ba85e4a5db473ca5","maxLength":32,"minLength":32,"pattern":"[a-fA-F0-9]{32}","type":"string","x-ifnull":"hide"}},"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"1f80f0bc298043fb850f251f3ab6d505","info_version":"v3","method":"get","name":"ListSwitchoverTestRecords","parameters":null,"paths":{"/v3/{project_id}/dcaas/switchover-test":{"get":{"description":"查询倒换测试记录列表,只展示operate_status为COMPELTE的记录。","operationId":"ListSwitchoverTestRecords","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Marker"},{"$ref":"#/components/parameters/Fields"},{"$ref":"#/components/parameters/SortDir"},{"$ref":"#/components/parameters/SortKey"},{"$ref":"#/components/parameters/QueryByResourceId"}],"responses":{"200":{"content":{"application/json":{"example":{"request_id":"bb154519fb167f99cdb01b7b9995ad14","switchover_test_records":[{"end_time":"2023-10-10T10:41:23.000Z","id":"862d61f1-d9ea-4093-ba0e-2b8d415e3ab3","operate_status":"COMPLETE","operation":"shutdown","resource_id":"d0b3329c-0063-470c-b1dc-657656b2e540","resource_type":"virtual_interface","start_time":"2023-10-10T10:41:23.000Z","tenant_id":"de58f033eb664102ba85e4a5db473ca5"}]},"schema":{"$ref":"#/components/schemas/ListSwitchoverTestRecordsResponseBody"}}},"description":"OK"}},"summary":"查询虚拟接口倒换测试记录列表","tags":["VirtualInterface"],"x-apiexplorer-hide":"false","x-is-registered":"Y","x-open-region-cloud":"hws,hws_hk","x-request-examples-description-1":"查询倒换测试记录列表","x-request-examples-url-1":"GET https://{dc_endpoint}/v3/de58f033eb664102ba85e4a5db473ca5/dcaas/switchover-test","x-support-sdk":"Y"}}},"product_short":"DC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询虚拟接口倒换测试记录列表","tags":"虚拟接口","uri":null,"version":"3.0.1"}