huawei-cloud-api-definitions-KooMessage 0.1.20260108

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"MsgAppRequest":{"description":"创建短信应用请求体。","properties":{"app_name":{"description":"应用名称。","example":"Huawei_1230","maxLength":30,"minLength":1,"type":"string"},"up_link_addr":{"description":"上行回调地址。支持通信协议HTTPS/HTTP。","example":"https://www.huaweicloud.com/sms/receive","maxLength":255,"type":"string"}},"required":["app_name"],"type":"object"},"SmsAppVo":{"description":"创建短信应用响应体。","properties":{"app_id":{"description":"应用ID。","maxLength":50,"minLength":1,"type":"string"},"app_name":{"description":"应用名称。","maxLength":30,"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"}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"77b9a82cdacd4d36a118841d1261ba9a","info_version":"v1","method":"put","name":"UpdateAimMsgApp","parameters":{},"paths":{"/v1/sms/apps/{app_id}":{"put":{"consumes":["application/json"],"description":"该接口用于用户修改短信应用。","operationId":"UpdateAimMsgApp","parameters":[{"description":"应用ID。","in":"path","name":"app_id","required":true,"type":"string"},{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"修改短信应用接口请求体。","in":"body","name":"UpdateAimMsgAppRequestBody","required":true,"schema":{"$ref":"#/definitions/MsgAppRequest"}},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"修改短信应用响应体。","examples":{"application/json":{"app_id":"2353cb25-c169-4e20-adcf-3517****0f9e","app_name":"应用2"}},"schema":{"$ref":"#/definitions/SmsAppVo"}},"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":"PUT","name":"lb-km-aim","path":"/v1/sms/apps/{id}","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-1":{"app_name":"应用2","up_link_addr":"https://www.huaweicloud.cn"},"x-request-examples-description-1":"修改ID为2353cb25-c169-4e20-adcf-3517****0f9e的短信应用。","x-request-examples-text-1":{"app_name":"应用2","up_link_addr":"https://www.huaweicloud.cn"},"x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/sms/apps/2353cb25-c169-4e20-adcf-3517****0f9e","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"}