huawei-cloud-api-definitions-DataArtsStudio 0.1.20250411

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ApiOverview":{"properties":{"create_time":{"description":"API 创建时间","format":"int64","type":"integer"},"create_user":{"description":"API创建者","type":"string"},"debug_status":{"description":"API调试状态(共享版)","enum":["API_DEBUG_WAITING","API_DEBUG_FAILED","API_DEBUG_SUCCESS"],"type":"string"},"description":{"description":"API描述","type":"string"},"group_id":{"description":"API分组ID(共享版)","type":"string"},"id":{"description":"API ID","type":"string"},"manager":{"description":"API审核人","type":"string"},"name":{"description":"API名称","type":"string"},"publish_messages":{"description":"发布信息列表(专享版)","items":{"$ref":"#/definitions/ApiPublishDTO"},"type":"array"},"status":{"description":"API状态(共享版)","enum":["API_STATUS_CREATED","API_STATUS_PUBLISH_WAIT_REVIEW","API_STATUS_PUBLISH_REJECT","API_STATUS_PUBLISHED","API_STATUS_WAITING_STOP","API_STATUS_STOPPED","API_STATUS_RECOVER_WAIT_REVIEW","API_STATUS_WAITING_OFFLINE","API_STATUS_OFFLINE","API_STATUS_OFFLINE_WAIT_REVIEW"],"type":"string"},"type":{"description":"API 类型","enum":["API_SPECIFIC_TYPE_CONFIGURATION","API_SPECIFIC_TYPE_SCRIPT","API_SPECIFIC_TYPE_REGISTER"],"type":"string"}},"type":"object"},"ApiOverviewBatch":{"example":{"records":[{"create_time":1579162215000,"debug_status":"API_DEBUG_WAITING","group_id":"677942eeca42b85d82fcef909d8345f4","id":"fd0beac79418d65e3b3ed24a6e33b24b","manager":"admin","name":"testApi","status":"API_STATUS_CREATED","type":"API_SPECIFIC_TYPE_REGISTER"}],"total":1},"properties":{"records":{"description":"API列表","items":{"$ref":"#/definitions/ApiOverview"},"type":"array"},"total":{"description":"API总数量","format":"int32","type":"integer"}},"type":"object"},"ApiPublishDTO":{"properties":{"api_debug":{"description":"api调试状态","enum":["API_DEBUG_WAITING","API_DEBUG_FAILED","API_DEBUG_SUCCESS"],"type":"string"},"api_id":{"description":"api编号","example":"47046fe7830c1be77cb0dc23bd86afa5","type":"string"},"api_status":{"description":"api状态","enum":["API_STATUS_CREATED","API_STATUS_PUBLISH_WAIT_REVIEW","API_STATUS_PUBLISH_REJECT","API_STATUS_PUBLISHED","API_STATUS_WAITING_STOP","API_STATUS_STOPPED","API_STATUS_RECOVER_WAIT_REVIEW","API_STATUS_WAITING_OFFLINE","API_STATUS_OFFLINE"],"type":"string"},"id":{"description":"发布编号","example":"343a6d4c0ad108376ebd060c9c33cc33","type":"string"},"instance_id":{"description":"集群编号","example":"c2e27497562ed193583378e052248003","type":"string"},"instance_name":{"description":"集群名称","example":"cluster_test_001","type":"string"}},"type":"object"},"ErrorResponse":{"properties":{"error_code":{"description":"错误码","example":"DLS.1000","maxLength":128,"minLength":1,"type":"string"},"error_msg":{"description":"错误描述","example":"process failed","maxLength":10240,"minLength":1,"type":"string"}},"type":"object"}},"description":null,"group_id":"23bb69798aaf409da161a43a90617121","host":"dayu.cn-north-4.myhuaweicloud.com","id":"a8eb279f13c84976bb340499b9c36067","info_version":"v1","method":"get","name":"ListApis","parameters":{},"paths":{"/v1/{project_id}/service/apis":{"get":{"description":"查询API列表","operationId":"ListApis","parameters":[{"description":"IAM Token","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"工作空间id","in":"header","name":"workspace","required":true,"type":"string"},{"description":"dlm版本类型","enum":["SHARED","EXCLUSIVE"],"in":"header","name":"Dlm-Type","required":false,"type":"string"},{"default":"application/json","description":"资源类型","in":"header","name":"Content-Type","required":true,"type":"string"},{"default":false,"description":"是否返回专享版API的发布信息","in":"header","name":"x-return-publish-messages","required":false,"type":"string"},{"description":"租户ID","in":"path","name":"project_id","required":true,"type":"string"},{"default":0,"description":"查询起始坐标, 即跳过前X条数据。仅支持0或limit的整数倍,不满足则向下取整","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"default":10,"description":"查询条数, 即查询Y条数据","format":"int32","in":"query","name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ApiOverviewBatch"}},"400":{"description":"BadRequest","schema":{"$ref":"#/definitions/ErrorResponse"}}},"summary":"查询API列表","tags":["API管理接口"],"x-support-sdk":"Y"}}},"product_short":"DataArtsStudio","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询API列表","tags":"API管理接口","uri":null,"version":"2.0"}