huawei-cloud-api-definitions-RDS 0.1.20260724

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例名称已存在。","type":"string"}},"required":["error_code","error_msg"]},"ListDbAgentJobsResponseBody":{"description":"数据库代理作业列表响应信息。","properties":{"jobs":{"description":"作业列表。","items":{"$ref":"#/definitions/ListDbAgentJobsResult"},"type":"array"},"total_count":{"description":"作业总数。","example":1,"type":"integer"}}},"ListDbAgentJobsResult":{"description":"数据库代理作业响应信息。","properties":{"agent_type":{"description":"作业代理的类型。\n\nsnapshot:快照代理\nlog_reader:日志读取器代理\ndistribution:分发代理\nmerge:合并代理\nqueue_reader:队列读取器代理。","type":"string"},"failure_count":{"description":"历史失败次数。","type":"integer"},"is_enabled":{"description":"是否可用。\n\ntrue:可用。\nfalse:不可用。","example":true,"type":"boolean"},"job_id":{"description":"作业id。","example":"BC809208-4C1E-44DC-AF98-48E71B374440","type":"string"},"job_name":{"description":"作业名。","example":"Distribution clean up: distribution","type":"string"},"last_failure_time":{"description":"最近失败时间。格式为“yyyy-mm-ddThh:mm:ssZ”。\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","example":"2023-01-05T08:00:00+0000","type":"string"},"profile_id":{"description":"配置文件id。作业类型为replication时特有。","example":"1","type":"string"},"profile_name":{"description":"配置文件名。作业类型为replication时特有。","example":"Default agent profile","type":"string"},"run_status":{"description":"作业执行状态。取值如下:\n\nfailed:失败。\nsucceeded:成功。\nretrying:重试中。\ncanceled:已取消。\nin_progress:正在运行。","example":"succeeded","type":"string"},"run_time":{"description":"最新执行时间。格式为“yyyy-mm-ddThh:mm:ssZ”。\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","example":"2023-01-05T08:00:00+0000","type":"string"}}}},"description":null,"group_id":"b7735f867ef44182af9eb77490a46fbf","host":"rds.cn-north-4.myhuaweicloud.com","id":"a3173c4a10f641f79224db7f07b16de9","info_version":"v3","method":"get","name":"ListDbAgentJobs","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/db-jobs":{"get":{"description":"查询数据库代理作业列表。","operationId":"ListDbAgentJobs","parameters":[{"description":"项目ID","in":"path","name":"project_id","required":true,"type":"string"},{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"语言。默认en-us。","in":"header","name":"X-Language","required":false,"type":"string"},{"description":"实例ID","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"作业类型。默认不传,查询所有作业。\n若传,则取值如下:\nreplication:发布订阅相关作业。","in":"query","name":"job_type","type":"string"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","in":"query","name":"offset","type":"integer"},{"description":"查询记录数。默认为10,不能为负数,最小值为1,最大值为100。","in":"query","name":"limit","type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"success","examples":{"application/json":{"jobs":[{"agent_type":"snapshot","failure_count":1,"is_enabled":true,"job_id":"BC809208-4C1E-44DC-AF98-48E71B374440","job_name":"Distribution clean up: distribution","last_failure_time":"2023-01-05T08:00:00+0000","profile_id":"1","profile_name":"Default agent profile","publication_name":"pub_name","run_status":"succeeded","run_time":"2023-01-05T08:00:00+0000"}],"total_count":1}},"schema":{"$ref":"#/definitions/ListDbAgentJobsResponseBody"}},"default":{"description":"error","schema":{"$ref":"#/definitions/ErrorResponse"}}},"summary":"查询数据库代理作业列表","tags":["发布订阅(SQL Server)"],"x-request-examples-url-1":"GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/1aa833000a124455a6801e83cca37e6ein04/db-jobs","x-support-sdk":"Y"}}},"product_short":"RDS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询数据库代理作业列表","tags":"发布订阅(SQL Server)","uri":null,"version":"2.0"}