huawei-cloud-api-definitions-ManageOneOCHCS 0.1.20260605

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{},"description":null,"group_id":"a58bba086da947389167b8c3715f7155","host":"hcs.cn-north-4.myhuaweicloud.com","id":"c063cabf26a84d5693385f99c72e86d1","info_version":"v1","method":"get","name":"ListCSMCIRelationInstances","parameters":{},"paths":{"/rest/cmdb/v1/instances/relations/{relationName}":{"get":{"consumes":["application/json"],"description":"条件查询某类型关系的所有实例。\n\n**接口SLA:**\n\n|SLA项|定义|\n|-----|-----|\n|请求成功率| ≥ 99.9%|\n|可用性|Tier1|\n|数据一致性|最终一致,不一致时长<1分钟|\n|吞吐量|10 tps|\n|TP50请求时延|500 ms|\n|TP99.9请求时延|1000 ms|","operationId":"ListCSMCIRelationInstances","parameters":[{"description":"IAM_OP token、SSO token。","in":"header","name":"x-auth-token","required":true,"type":"string"},{"description":"资源关系名称。","in":"path","maxLength":60,"minLength":1,"name":"relationName","required":true,"type":"string"},{"default":1,"description":"页码,默认值1。","format":"int32","in":"query","minimum":1,"name":"pageNo","type":"integer"},{"default":20,"description":"页大小,默认值20。","format":"int32","in":"query","maximum":1000,"minimum":1,"name":"pageSize","type":"integer"},{"description":"要返回的字段,默认返回所有字段,格式:[\"attr1\",\"attr2\"]。","in":"query","name":"contentSelector","type":"string"},{"description":"排序方式,格式:[{\"field\":\"attr1\",\"asc\":true}]。分页查询时,建议填写该参数明确排序字段和排序方式,确保返回数据顺序的唯一性,否则无法确保返回数据顺序唯一性。","in":"query","name":"orderBy","type":"string"},{"description":"查询条件,受Http Header最大81920字符限制。条件示例:[{\"simple\":{\"name\":\"source_Instance_Id\",\"value\":\"C726DF8E2E8446FDA17D6D3B7C495DFF\",\"operator\":\"equal\"}},{\"logOp\":\"and\",\"simple\":{\"caseSensitive\":false,\"name\":\"target_Instance_Id\",\"value\":\"59DBFB6123593CC585841CAE0A4F4844\",\"operator\":\"equal\"}}]。字段说明:Condition(关键字),Simple(关键字),logOp(条件连接符,可取的值有\"and\",\"or\"),name(资源的属性属性名称),value(属性值),operator(运算符,可取的值有\"equal\",\"not equal\",\"contain\",\"not contain\",\"in\",\"not in\",\"is null\",\"not null\"等)。条件说明:{\"simple\":{\"name\":\"source_Instance_Id\",\"value\":\"C726DF8E2E8446FDA17D6D3B7C495DFF\",\"operator\":\"equal\"}}表示source_Instance_Id=\"C726DF8E2E8446FDA17D6D3B7C495DFF\"。{\"logOp\":\"and\",\"simple\":{\"caseSensitive\":false,\"name\":\"target_Instance_Id\",\"value\":\"59DBFB6123593CC585841CAE0A4F4844\",\"operator\":\"equal\"}}表示target_Instance_Id=\"59DBFB6123593CC585841CAE0A4F4844\",加上\"caseSensitive\":false则表示属性值不区分大小写,\"logOp\":\"and\"表示这个查询条件与上一个条件是and关系。","in":"query","name":"condition","type":"string"},{"default":true,"description":"是否统计实例数量,默认值true。预留字段,目前暂不支持按条件查询。","in":"query","name":"count","type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"条件查询某类型关系的所有实例。获取响应体请参考《资源北向模型》。","examples":{"application/json":{"currentPage":1,"objList":[{"id":"C726DF8E2E8446FDA17D6D3B7C495D00","last_Modified":1496321202457,"relation_Id":1011,"relation_Name":"M_RoomContainsRack","resId":"C726DF8E2E8446FDA17D6D3B7C495D11","source_Instance_Id":"C726DF8E2E8446FDA17D6D3B7C495DFF","target_Instance_Id":"C726DF8E2E8446FDA17D6D3B7C495D11"}],"pageSize":20,"totalNum":1,"totalPageNo":1}}},"400":{"description":"参数错误。"},"403":{"description":"URL鉴权失败。"},"404":{"description":"rest接口未找到。"},"500":{"description":"默认ServiceException异常码,应用内部错误。"},"502":{"description":"网关错误。"},"503":{"description":"服务不可用。"},"504":{"description":"表示时间超时,总线超时时间300s。"},"888":{"description":"服务摘机,不提供服务。"}},"summary":"条件查询某类型关系的所有实例","tags":["资源管理"],"x-precautions":"使用前请参考《资源北向模型》,获取系统支持的资源类型、关系类型、资源分类及属性列表。调用该接口需要“查询实例详情”权限,归属权限组:运维中心>资源实例管理。\n错误码:当请求不成功时,响应体内的错误码信息请参见“ManageOne 运维面API参考 > 错误码说明 > 资源管理特性”章节。\n","x-request-examples-1":"","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/rest/cmdb/v1/instances/relations/M_RoomContainsRack?pageSize=20&pageNo=1&condition=[{\"simple\":{\"name\":\"source_Instance_Id\",\"value\":\"5A967E72E4F436F39FF45E834D5DAE88\",\"operator\":\"equal\"}},{\"logOp\":\"and\",\"simple\":{\"caseSensitive\":false,\"name\":\"target_Instance_Id\",\"value\":\"59DBFB6123593CC585841CAE0A4F4844\",\"operator\":\"equal\"}}]","x-support-sdk":"N"}}},"product_short":"ManageOneOCHCS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"条件查询某类型关系的所有实例","tags":"资源管理","uri":null,"version":"2.0"}