huawei-cloud-api-definitions-KooMessage 0.1.20240404

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"Page":{"description":"分页信息。","properties":{"limit":{"description":"每页显示的条目数量。","example":20,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","example":1,"type":"integer"},"total":{"description":"总条数。","example":222,"type":"integer"}}},"SmsApp":{"properties":{"app_id":{"description":"应用ID,用于获取、修改应用的唯一标识。","maxLength":50,"minLength":1,"type":"string"},"app_name":{"description":"应用名称。","maxLength":30,"minLength":1,"type":"string"},"create_time":{"description":"创建时间,格式:yyyy-MM-dd'T'HH:mm:ss。","maxLength":20,"minLength":1,"type":"string"},"region":{"description":"地域。","maxLength":20,"minLength":1,"type":"string"},"status":{"description":"状态。","enum":["CREATED:待上线。应用暂未创建成功,请稍候","SUSPENDED:暂停。无法发起业务请求。当客户所发短信内容触发业务违规,或客户申请退订短信业务时,运营经理会将客户短信应用暂停","LAUNCHED:正常。应用添加成功,可以正常使用"],"maxLength":20,"minLength":1,"type":"string"},"up_link_addr":{"description":"上行短信地址。","maxLength":255,"minLength":1,"type":"string"}},"type":"object"},"SmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","maxLength":32,"minLength":0,"type":"string"},"error_msg":{"description":"结果详情。","maxLength":32,"minLength":0,"type":"string"}},"type":"object"},"SmsPageResponse1":{"description":"短信记录查询结果。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"result":{"description":"查询结果。","items":{"$ref":"#/definitions/SmsApp"},"type":"array"}},"type":"object"}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"52238621661e4d2993daf6e8f842aed9","info_version":"v1","method":"get","name":"ListAimMsgApp","parameters":{},"paths":{"/v1/sms/apps":{"get":{"description":"该接口用于用户查询已创建的短信应用。","operationId":"ListAimMsgApp","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"default":10,"description":"每页显示的条目数量。","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"description":"应用名称。","in":"query","maxLength":30,"minLength":1,"name":"app_name","required":false,"type":"string"},{"description":"应用状态。","in":"query","name":"status","required":false,"type":"string"},{"description":"创建时间筛选-开始时间。格式为:2019-10-12T07:20:50Z。","in":"query","name":"begin_time","required":false,"type":"string"},{"description":"创建时间筛选-结束时间。格式为:2019-10-12T07:20:50Z。","in":"query","name":"end_time","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"查询短信应用响应体。","examples":{"application/json":{"page_info":{"limit":2,"offset":0,"total":1},"result":[{"app_id":"2353cb25-c169-4e20-adcf-****7b4e0f9e","app_name":"AAAAA","create_time":"2023-08-07T02:21:26","region":"cn","status":"LAUNCHED","up_link_addr":"https://www.huaweicloud.com/sms/receive"}]}},"schema":{"$ref":"#/definitions/SmsPageResponse1"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/SmsErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/SmsErrorMsg"}}},"schemes":["https"],"security":[{"apig-auth-iam":[]}],"summary":"查询短信应用","tags":["AimSmsApp"],"x-api-type":"open-api","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"GET","name":"lb-km-aim","path":"/v1/sms/apps","scheme":"https","timeout":30000},"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-query-string-encode":"ENABLE","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-description-1":"根据名称查询短信应用列表。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/sms/apps?offset=0&limit=2&app_name=AAAAA","x-support-sdk":"Y"}}},"product_short":"KooMessage","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"查询短信应用","tags":"短信应用","uri":null,"version":"2.0"}