huawei-cloud-api-definitions-iDMEClassicAPI 0.1.20250829

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"GenerateTokenResultDto":{"properties":{"app_id":{"description":"**参数解释**:\n\n应用ID。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"},"token":{"description":"**参数解释**:\n\n认证token。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"},"user_id":{"description":"**参数解释**:\n\n用户ID。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"},"user_name":{"description":"**参数解释**:\n\n用户名。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"}},"type":"object"},"GetTokenDto":{"properties":{"auth_type":{"description":"**参数解释**:\n\n认证类型。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n- read:只读。\n- write:读写。\n\n**默认取值**:\n\n不涉及。","type":"string"},"doc_id":{"description":"**参数解释**:\n\n文档ID。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n不涉及。\n\n**默认取值**:\n\n不涉及。","type":"string"}},"required":["auth_type","doc_id"],"type":"object"},"GetTokenResp":{"properties":{"data":{"description":"**参数解释:**\n\n请求数据。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","items":{"$ref":"#/definitions/GenerateTokenResultDto"},"type":"array"},"errors":{"$ref":"#/definitions/errors"},"result":{"$ref":"#/definitions/result"}},"type":"object"},"RDMParamVOGetTokenDto":{"properties":{"applicationId":{"description":"**参数解释**:\n\n应用ID。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n由英文字母和数字组成,且长度为32个字符。\n\n**默认取值**:\n\n不涉及。","type":"string"},"params":{"$ref":"#/definitions/GetTokenDto","description":"**参数解释:**\n\n请求参数对象。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。"}},"required":["params"],"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":"819cb3df9dbb4f7c9501434f4cd5fb72","info_version":"v1","method":"post","name":"ShowGetTokens","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}/structured-doc/tokens":{"post":{"consumes":["application/json"],"description":"该接口可以用于通过文档ID和认证类型的方式进行认证来获取结构化文档的Token。","operationId":"ShowGetTokens","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不涉及。","in":"path","name":"modelName","required":true,"type":"string","x-example":"StructuredDocableModel"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RDMParamVOGetTokenDto"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"data":[{"app_id":"20240910111314182-0683-5DD122D41","token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ7XCJ1c2VyTmFtZVwiOlwiWERNX0RldmVsb3BlclwiLFwiYXV0aFR5cGVcIjpcIjFcIixcInVzZXJJZFwiOlwiOTMxNzJiYmZkMGY2NDQzNzk1NmQ0YzlkZTkzNDUzODZcIn0iLCJkb2MiOiJ7XCJkb2N1bWVudElkXCI6XCIxOTYxOWFjMC0yMmVlLTQwNWEtYmYzNS01MzY3M2VmYTMyNjdcIn0iLCJleHAiOjE3MzY5NDg5MjR9.7VdVR6lpErzKdpqVvre_Yj2OWtQ86dzrbhtAi0d50DE","user_id":"93172bbfd0f64437956d4c9de9345386","user_name":"XDM_Developer"}],"errors":[],"result":"SUCCESS"}},"schema":{"$ref":"#/definitions/GetTokenResp"}}},"summary":"获取Token信息","tags":["结构化文档管理"],"x-constraint":"功能列表勾选了结构化文档管理的模型可以使用该接口。","x-is-registered":"Y","x-request-examples-1":{"params":{"auth_type":"read","doc_id":"19619ac0-22ee-405a-bf35-53673efa3267"}},"x-request-examples-text-1":{"params":{"auth_type":"read","doc_id":"19619ac0-22ee-405a-bf35-53673efa3267"}},"x-request-examples-url-1":"POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/structured-doc/tokens","x-support-sdk":"Y","x-version":"v1"}}},"product_short":"iDMEClassicAPI","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取Token信息","tags":"结构化文档管理","uri":null,"version":"2.0"}