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":{"AddUserToApp":{"example":{"users":[{"id":"06d9106f3b000f241f83c010d6b78c81","roles":["read"]}]},"properties":{"users":{"$ref":"#/definitions/AddUsers"}},"type":"object"},"AddUsers":{"description":"要添加的用户成员列表,空列表时代表清空应用的所有成员","items":{"$ref":"#/definitions/User"},"minItems":0,"type":"array"},"AppId":{"description":"应用ID","example":"b2e6b145-4f3f-4a80-aa45-f4b8029f95a3","type":"string"},"AppUserRoles":{"description":"应用权限角色\n- read:应用下资源只读权限,至少要存在此权限,包括API调试\n- access:应用下资源的访问管理权限\n- delete:应用下资源的删除权限\n- modify:应用下资源的修改权限,包括API发布、下线\n- admin:应用和应用下资源的权限\n- 仅提供admin时,会自动应用其它所有权限\n- 未提供read时会自动应用read权限","example":["read","access","delete","modify","admin"],"items":{"enum":["read","access","delete","modify","admin"],"minItems":1,"required":["read"],"type":"string"},"type":"array"},"AppUsers":{"properties":{"id":{"$ref":"#/definitions/AppId"},"total":{"description":"应用的总成员数量","example":1,"maximum":5,"minimum":1,"type":"integer"},"users":{"description":"用户成员列表","items":{"properties":{"id":{"description":"用户ID","type":"string"},"name":{"description":"用户名称","type":"string"},"roles":{"$ref":"#/definitions/AppUserRoles"}},"type":"string"},"maxItems":5,"minItems":1,"type":"array"}},"type":"object"},"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"},"User":{"properties":{"id":{"description":"用户ID","type":"string"},"roles":{"$ref":"#/definitions/AppUserRoles"}}}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"efad24dad3484aeda274f7a4d488b2ca","info_version":"v2","method":"put","name":"AddUserToApp","parameters":{},"paths":{"/v2/{project_id}/instances/{instance_id}/apps/{app_id}/users":{"put":{"description":"- 设置应用的用户成员,为空数组时会清空已有应用成员列表\n- 设置动作为全量更新非增量更新,应用的成员列表都会替换为当次请求的应用成员列表","operationId":"AddUserToApp","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":"app_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"},{"description":"设置应用成员请求消息体","in":"body","name":"AddUserToAppRequestBody","required":true,"schema":{"$ref":"#/definitions/AddUserToApp"}}],"responses":{"200":{"description":"OK","examples":{"application/json":{"id":"b2e6b145-4f3f-4a80-aa45-f4b8029f95a3","total":1,"users":[{"id":"string","name":"string","roles":["read, access, delete, modify, admin"]}]}},"schema":{"$ref":"#/definitions/AppUsers"}},"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":["APPLICATION_MANAGEMENT"],"x-apigateway-backend":{"httpEndpoints":{"address":"#roma-address#","description":"","method":"PUT","path":"/v2/{project_id}/instances/{instance_id}/apps/{app_id}/users","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"PATH","name":"app_id","origin":"REQUEST","value":"app_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":"APPLICATION_MANAGEMENT","uri":null,"version":"2.0"}