huawei-cloud-api-definitions-iDMEClassicAPI 0.1.20250214

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"GetByUniqueKeyResp":{"properties":{"data":{"description":"请求数据。","items":{"$ref":"#/definitions/PersistableModelViewDTO"},"type":"array"},"errors":{"$ref":"#/definitions/errors"},"result":{"$ref":"#/definitions/result"}},"type":"object"},"PersistableModelUniqueKeyDTO":{"properties":{"decrypt":{"description":"**参数解释:**\n\n是否加密。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- true:加密。\n- false:不加密。\n\n**默认取值:**\n\nfalse。\n","example":false,"type":"boolean"},"uniqueKey":{"description":"**参数解释:**\n\n示例模型的唯一键约束属性值。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"unionKey instance","type":"string"}},"required":["uniqueKey"],"type":"object"},"PersistableModelViewDTO":{"properties":{"className":{"description":"**参数解释:**\n\n类名。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"AircraftModel","type":"string"},"createTime":{"description":"**参数解释:**\n\n创建时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"2023-12-02T03:03:07.695+0000","type":"string"},"creator":{"description":"**参数解释:**\n\n创建者。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"test1","type":"string"},"id":{"description":"**参数解释:**\n\n唯一标识。\n\n**取值范围:**\n\n-9223372036854775808到9223372036854775807的整数。\n\n**默认取值:**\n\n不涉及。\n","example":"553535480021389312","type":"string"},"lastUpdateTime":{"description":"**参数解释:**\n\n最后更新时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"},"modifier":{"description":"**参数解释:**\n\n修改人。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"test1","type":"string"},"rdmDeleteFlag":{"description":"**参数解释:**\n\n软删除标识。\n\n**取值范围:**\n\n- 0:表示未删除。\n- 1:表示已删除。\n\n**默认取值:**\n\n0。\n","example":0,"format":"int32","type":"integer"},"rdmExtensionType":{"description":"**参数解释:**\n\n扩展类型。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"AircraftModel","type":"string"},"rdmVersion":{"description":"**参数解释:**\n\n系统版本。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":1,"format":"int32","type":"integer"},"tenant":{"$ref":"#/definitions/TenantViewDTO","description":"**参数解释:**\n\n租户信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"},"uniqueKey":{"description":"**参数解释:**\n\n示例模型中定义的唯一键属性。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"31415926548645665","type":"string"}},"type":"object"},"RDMParamVOPersistableModelUniqueKeyDTO":{"properties":{"applicationId":{"description":"**参数解释**:\n\n应用ID。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n由英文字母和数字组成,且长度为32个字符。\n\n**默认取值**:\n\n不涉及。\n","example":"b3f9b7523a6141f4b2d76b92d6595281","type":"string"},"params":{"$ref":"#/definitions/PersistableModelUniqueKeyDTO","description":"**参数解释:**\n\n请求参数对象。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"}},"type":"object"},"TenantViewDTO":{"properties":{"className":{"description":"**参数解释:**\n\n类名。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"Tenant","type":"string"},"code":{"description":"**参数解释:**\n\n租户编码。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"basicTenant","type":"string"},"createTime":{"description":"**参数解释:**\n\n创建时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"2023-12-02T03:03:07.695+0000","type":"string"},"creator":{"description":"**参数解释:**\n\n创建者。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"test1","type":"string"},"dataSource":{"description":"**参数解释:**\n\n租户使用的数据源名称。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"DefaultDataSource","type":"string"},"description":{"description":"**参数解释:**\n\n描述信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"默认租户","type":"string"},"disableFlag":{"description":"**参数解释:**\n\n失效标识。 \n\n**取值范围:**\n\n- true:失效。 \n- false:未失效。\n\n**默认取值:**\n\nfalse。\n","example":false,"type":"boolean"},"id":{"description":"**参数解释:**\n\n唯一标识。 \n\n**取值范围:**\n\n-9223372036854775808到9223372036854775807的整数。\n\n**默认取值:**\n\n不涉及。\n","example":"-1","type":"string"},"kiaguid":{"description":"**参数解释:**\n\nKIA密级。 \n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","type":"string"},"lastUpdateTime":{"description":"**参数解释:**\n\n最后更新时间。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","type":"string"},"modifier":{"description":"**参数解释:**\n\n修改人。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"test1","type":"string"},"name":{"description":"**参数解释:**\n\n中文名称。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"basicTenant","type":"string"},"rdmDeleteFlag":{"description":"**参数解释:**\n\n软删除标识。\n\n**取值范围:**\n\n- 0:表示未删除。\n- 1:表示已删除。\n\n**默认取值:**\n\n0。\n","example":0,"format":"int32","type":"integer"},"rdmExtensionType":{"description":"**参数解释:**\n\n扩展类型。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"Tenant","type":"string"},"rdmVersion":{"description":"**参数解释:**\n\n系统版本。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":1,"format":"int32","type":"integer"},"securityLevel":{"description":"**参数解释:**\n\n安全密级。\n\n**取值范围:**\n\n- INTERNAL:内部公开。\n- SECRET:秘密。\n- CONFIDENTIAL:机密。\n- TOP_SECRET:绝密。\n\n**默认取值:**\n\n不涉及。\n","example":"INTERNAL","type":"string"},"tenant":{"$ref":"#/definitions/TenantViewDTO","description":"**参数解释:**\n\n租户信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"}},"required":["code","dataSource"],"type":"object"},"errors":{"description":"**参数解释:**\n\n异常信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":[],"items":{"type":"string"},"type":"array"},"result":{"description":"**参数解释:**\n\n请求结果。\n\n**取值范围:**\n\n- SUCCESS:请求成功。\n- FAIL:请求失败。\n\n**默认取值:**\n\n不涉及。\n","example":"SUCCESS","type":"string"}},"description":null,"group_id":"ab5eda63b51647d6a950ceef4eccd859","host":"dme.cn-north-4.huaweicloud.com","id":"73d2cae6d390464ab02c884ad0ece020","info_version":"v1","method":"post","name":"ShowGetByUniqueKey","parameters":{"X-Auth-Token":{"description":"**参数解释:**\n\nIAM用户的token。\n\n获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。\n\n**约束限制:**  \n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**  \n\n不涉及。\n","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."},"identifier":{"description":"**参数解释:**\n\n应用唯一标识。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n由英文字母和数字组成,且长度为32个字符。\n\n**默认取值:**\n\n不涉及。\n","in":"path","name":"identifier","required":true,"type":"string","x-example":"b3f9b7523a6141f4b2d76b92d6595281"}},"paths":{"/rdm_{identifier}_app/publicservices/api/{modelName}/{getUniqueFieldMethod}":{"post":{"consumes":["application/json"],"description":"当数据模型中存在“唯一键”为“是”的属性时,可根据该属性查询实例数据。","operationId":"ShowGetByUniqueKey","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/identifier"},{"description":"**参数解释:**\n\n数据模型的英文名称。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。\n\n**默认取值:**\n\n不涉及。\n","in":"path","name":"modelName","required":true,"type":"string","x-example":"PersistableModel"},{"description":"**参数解释:**\n\n方法名称,格式为:getBy{uniqueName}。\n\nuniqueName:表示“唯一键”为“是”的属性英文名称。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","in":"path","name":"getUniqueFieldMethod","required":true,"type":"string","x-example":"getByUniqueKey"},{"description":"**参数解释:**\n\n请求参数对象。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","in":"body","name":"paramVO","required":true,"schema":{"$ref":"#/definitions/RDMParamVOPersistableModelUniqueKeyDTO"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"data":[{"className":"AircraftModel","createTime":"2023-09-27T06:18:03.000+0000","creator":"test1","id":"553535480021389300","lastUpdateTime":"2023-09-27T06:18:03.000+0000","modifier":"test1","rdmDeleteFlag":1,"rdmExtensionType":"AircraftModel","rdmVersion":1,"tenant":{"className":"Tenant","code":"basicTenant","createTime":"2023-09-27T06:18:03.000+0000","creator":"test1","dataSource":"DefaultDataSource","description":"默认租户","disableFlag":false,"id":-1,"kiaguid":"string","lastUpdateTime":"2023-09-27T06:18:03.000+0000","modifier":"test1","name":"basicTenant","rdmDeleteFlag":1,"rdmExtensionType":"Tenant","rdmVersion":1,"securityLevel":"INTERNAL","tenant":"string"},"uniqueKey":"31415926548645664"}],"errors":[],"result":"SUCCESS"}},"schema":{"$ref":"#/definitions/GetByUniqueKeyResp"}}},"summary":"根据唯一键为“是”的属性查询实例","tags":["基础数据服务"],"x-constraint":"模型存在唯一键约束的属性时才能使用该接口。","x-is-registered":"Y","x-order":17,"x-request-examples-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"decrypt":false,"uniqueKey":"unionKey instance"}},"x-request-examples-text-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"decrypt":false,"uniqueKey":"unionKey instance"}},"x-request-examples-url-1":"POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/getByUniqueKey","x-support-sdk":"Y","x-version":"v1"}}},"product_short":"iDMEClassicAPI","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"根据唯一键为“是”的属性查询实例","tags":"基础数据服务","uri":null,"version":"2.0"}