huawei-cloud-api-definitions-Classroom 0.1.20250418

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ClassroomCard":{"properties":{"classroom_id":{"description":"课堂ID","type":"string"},"credit":{"description":"课堂学分","type":"number"},"description":{"description":"课堂描述","type":"string"},"name":{"description":"课堂名称","type":"string"},"status":{"description":"课堂当前的状态,normal:课堂处于正常状态,archive:课堂已归档","type":"string"}},"required":["classroom_id","name","description","credit","status"],"type":"object"},"ClassroomListResult":{"properties":{"classrooms":{"description":"课堂列表","items":{"$ref":"#/definitions/ClassroomCard"},"type":"array"},"total":{"description":"课堂总数","type":"integer"}},"required":["classrooms","total"],"type":"object"}},"description":null,"group_id":"efb473a373f747f48f056d82c721a6dd","host":"classroom-ext.cn-north-4.myhuaweicloud.com","id":"8445d134c57c4ecca26e96bae2a86b5a","info_version":"v3","method":"get","name":"ListClassrooms","parameters":{},"paths":{"/v3/classrooms":{"get":{"description":"获取当前用户的课堂列表,课堂课表分为我创建的课堂,我加入的课堂以及所有课堂,支持分页查询。","operationId":"ListClassrooms","parameters":[{"description":"信息记录的起始编号","in":"query","maximum":1000,"minimum":1,"name":"offset","required":false,"type":"integer","x-example":1},{"description":"每页包含的信息记录数","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":1},{"description":"查询的课堂类别,默认查询所有的课堂。 取值范围: create:只查询当前用户创建的课堂。 attend:只查询当前用户加入的课堂。 all:查询当前用户所有的课堂。","in":"query","maxLength":6,"minLength":3,"name":"query_type","required":false,"type":"string","x-example":"all"},{"description":"用户token","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvIIDgzCCXXXXXX..."}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"classrooms":[{"classroom_id":"0632910a5115448da1eb92202592fa24","credit":1.5,"description":"这是第一个课堂","name":"Java高级编程","status":"normal"}],"total":1}},"schema":{"$ref":"#/definitions/ClassroomListResult","type":"object"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"CM.0003","error_msg":"请求参数有误"}}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"CM.0001","error_msg":"请求被拒绝访问"}}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"CM.0000","error_msg":"服务内部错误"}}}},"summary":"获取当前用户的课堂列表","tags":["classroom"],"x-is-registered":"Y","x-request-examples-1":"GET https://{endpoint}/v3/classrooms","x-request-examples-text-1":"GET https://{endpoint}/v3/classrooms","x-support-sdk":"Y"}}},"product_short":"Classroom","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取当前用户的课堂列表","tags":"classroom","uri":null,"version":"2.0"}