huawei-cloud-api-definitions-GaussDB 0.1.20250124

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"GetJobEntitiesInfoDetail":{"description":"根据不同的任务,显示不同的内容。","type":"object"},"GetJobInfoDetail":{"description":"任务信息。","properties":{"created":{"description":"创建时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。\n\n说明:创建时返回值为空,数据库实例创建成功后该值不为空。","type":"string"},"ended":{"description":"结束时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。\n\n说明:创建时返回值为空,数据库实例创建成功后该值不为空。","type":"string"},"entities":{"$ref":"#/definitions/GetJobEntitiesInfoDetail"},"fail_reason":{"description":"任务执行失败时的错误信息。","type":"string"},"id":{"description":"任务ID。","type":"string"},"instance":{"$ref":"#/definitions/GetJobInstanceInfoDetail"},"name":{"description":"任务名称。","type":"string"},"process":{"description":"任务执行进度。执行中状态才返回执行进度,例如60%,否则返回\"\"。","type":"string"},"status":{"description":"任务执行状态。\n\n取值:\n- 值为“Pending”,表示延时任务,未执行。\n- 值为“Running”,表示任务正在执行。\n- 值为“Completed”,表示任务执行成功。\n- 值为“Failed”,表示任务执行失败。","enum":["Pending","Running","Completed","Failed"],"type":"string"}},"required":["id","name","status","created","instance"]},"GetJobInfoResponseBody":{"properties":{"job":{"$ref":"#/definitions/GetJobInfoDetail"}},"required":["job"]},"GetJobInstanceInfoDetail":{"description":"指定ID任务的实例信息。","properties":{"id":{"description":"实例ID。","type":"string"},"name":{"description":"实例名称。","type":"string"}},"required":["id","name"]},"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"b8aa878b8e924c56b67ca3fae1eab663","info_version":"v3","method":"get","name":"ShowGaussMySqlJobInfo","parameters":{},"paths":{"/v3/{project_id}/jobs":{"get":{"description":"获取GaussDB(for MySQL)任务中心指定ID的任务信息。","operationId":"ShowGaussMySqlJobInfo","parameters":[{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"语言。","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"租户在某一region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdbformysql/gaussdbformysql_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"任务ID。","in":"query","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"job":{"created":"2018-08-06T10:41:14+0800","ended":"2018-08-06T16:41:14+0000","entities":{"instance":{"datastore":{"type":"gaussdb-mysql","version":"8.0"},"endpoint":"192.168.1.203:3306","type":"Cluster"},"resource_ids":["a48e43ff268f4c0e879652d65e63d0fbin07.vm","a48e43ff268f4c0e879652d65e63d0fbin07.volume"]},"id":"31b8ae23-c687-4d80-b7b4-42a66c9bb886","instance":{"id":"a48e43ff268f4c0e879652d65e63d0fbin07","name":"DO-NOT-TOUCH-mgr2-mysql-single"},"name":"CreateGaussDBforMySQLInstance","process":"","status":"Completed"}}},"schema":{"$ref":"#/definitions/GetJobInfoResponseBody"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"获取指定ID的任务信息","tags":["任务中心"],"x-constraint":"- 该接口只可查询任务中心一个月内的异步任务。\n- job生成后,通常需要数秒之后才能查询到job ID。","x-is-registered":"N","x-request-examples-description-1":"获取指定ID的任务信息。","x-request-examples-url-1":"GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取指定ID的任务信息","tags":"任务中心","uri":null,"version":"2.0"}