huawei-cloud-api-definitions-ROMA 0.1.20240626

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"Dictionary":{"properties":{"code":{"$ref":"#/definitions/DictionaryCode"},"create_time":{"description":"创建时间","example":"2019-12-06T06:49:04Z","format":"dateTime","maximum":128,"minimum":1,"type":"string"},"extend_one":{"$ref":"#/definitions/DictionaryExtendOne"},"extend_two":{"$ref":"#/definitions/DictionaryExtendTwo"},"id":{"description":"字典ID","maxLength":64,"minLength":0,"type":"string"},"name":{"$ref":"#/definitions/DictionaryName"},"parent_code":{"$ref":"#/definitions/DictionaryParent"},"remark":{"$ref":"#/definitions/DictionaryRemark"},"type":{"$ref":"#/definitions/DictionaryType"},"update_time":{"description":"更新时间","example":"2019-12-06T06:49:04Z","format":"dateTime","maximum":128,"minimum":1,"type":"string"}},"type":"object"},"DictionaryCode":{"description":"字典编码\n- 字符集:英文字母、数字、下划线和空格\n- 约束:实例下唯一","maxLength":64,"minLength":2,"type":"string"},"DictionaryExtendOne":{"description":"字典扩展字段1\n- 字符集:中文、英文字母、数字、下划线和空格","maxLength":5000,"minLength":0,"type":"string"},"DictionaryExtendTwo":{"description":"字典扩展字段2\n- 字符集:中文、英文字母、数字、下划线和空格","maxLength":5000,"minLength":0,"type":"string"},"DictionaryName":{"description":"字典名称\n- 字符集:中文、英文字母、数字、下划线和空格\n- 约束:实例下唯一","maxLength":64,"minLength":2,"type":"string"},"DictionaryParent":{"description":"父字典编码,为空时代表自身就是最顶级字典","maxLength":64,"minLength":0,"type":"string"},"DictionaryRemark":{"description":"字典描述","maxLength":200,"minLength":0,"type":"string"},"DictionaryType":{"description":"字典类型\n- system: 代表系统内置字典,用户可编辑但不可删除\n- user: 代表用户创建字典","enum":["system","user"],"type":"string"},"ErrorResp":{"example":{"error_code":"ROMA.00000101","error_details":"some error details here","error_msg":"error summary","request_id":"13760c1fe8655e61209b75665e9bef43"},"properties":{"error_code":{"description":"错误码","maxLength":128,"minLength":1,"type":"string"},"error_details":{"description":"具体错误消息","maxLength":128,"minLength":1,"type":"string"},"error_msg":{"description":"错误消息","maxLength":128,"minLength":1,"type":"string"},"request_id":{"description":"请求处理ID","maxLength":128,"minLength":1,"type":"string"}},"type":"object"}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"fd7c24c870c34822a0ae9860d0d11ea0","info_version":"v2","method":"get","name":"CheckDictionary","parameters":{},"paths":{"/v2/{project_id}/instances/{instance_id}/dictionaries/{dict_id}":{"get":{"description":"查询字典详情,","operationId":"CheckDictionary","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)","in":"header","maxLength":100000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"字典ID","in":"path","maxLength":64,"minLength":0,"name":"dict_id","required":true,"type":"string"},{"description":"实例ID","in":"path","maxLength":64,"minLength":0,"name":"instance_id","required":true,"type":"string"},{"description":"项目ID","in":"path","maxLength":64,"minLength":0,"name":"project_id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","examples":{"application/json":{"code":"string","create_time":"2019-12-06T06:49:04Z","extend_one":"string","extend_two":"string","id":"string","name":"string","order":0,"parent_code":"string","remark":"string","type":"system","update_time":"2019-12-06T06:49:04Z"}},"schema":{"$ref":"#/definitions/Dictionary"}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"ROMA.00000101","error_details":"some error details here","error_msg":"error summary","request_id":"13760c1fe8655e61209b75665e9bef43"}},"schema":{"$ref":"#/definitions/ErrorResp"}}},"security":[{"apig-auth-iam":[]}],"summary":"查询字典详情","tags":["DICTIONARY_MANAGEMENT"],"x-apigateway-backend":{"httpEndpoints":{"address":"#roma-address#","description":"","method":"GET","path":"/v2/{project_id}/instances/{instance_id}/dictionaries/{dict_id}","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"PATH","name":"dict_id","origin":"REQUEST","value":"dict_id"},{"description":"","in":"PATH","name":"instance_id","origin":"REQUEST","value":"instance_id"},{"description":"","in":"PATH","name":"project_id","origin":"REQUEST","value":"project_id"}],"type":"HTTP"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-request-type":"public","x-is-registered":"Y","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询字典详情","tags":"DICTIONARY_MANAGEMENT","uri":null,"version":"2.0"}