huawei-cloud-api-definitions-KooMessage 0.1.20240202

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"ListMsgTemplateVariableResponse":{"description":"用户增长任务列表。","properties":{"results":{"description":"返回结果列表。","items":{"$ref":"#/definitions/VariableAttributesResponse"},"type":"array"},"total":{"description":"总数。","type":"integer"}},"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"},"VariableAttributesResponse":{"description":"用户增长任务列表。","properties":{"id":{"description":"ID。","type":"integer"},"variable_desc":{"description":"变量描述。","maxLength":100,"minLength":0,"type":"string"},"variable_index":{"description":"变量索引。","type":"integer"},"variable_length":{"description":"变量长度。","type":"integer"},"variable_type":{"description":"变量类型。","maxLength":20,"minLength":1,"type":"string"}},"type":"object"}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"52a281c5289b4a5483e83786a5b3dc01","info_version":"v1","method":"get","name":"ShowAimMsgTemplateVariable","parameters":{},"paths":{"/v1/sms/templates/{template_id}/variable":{"get":{"description":"该接口用于用户查询短信模板变量。","operationId":"ShowAimMsgTemplateVariable","parameters":[{"description":"短信模板ID。","in":"path","name":"template_id","required":true,"type":"string"},{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"查询短信模板变量列表响应体。","examples":{"application/json":{"results":[{"id":15005872,"variable_desc":"直发","variable_index":1,"variable_length":99,"variable_type":"NEWTEXT"}],"total":1}},"schema":{"$ref":"#/definitions/ListMsgTemplateVariableResponse"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/SmsErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/SmsErrorMsg"}}},"schemes":["https"],"security":[{"apig-auth-iam":[]}],"summary":"查询短信模板变量","tags":["AimSmsTemplate"],"x-api-type":"open-api","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"GET","name":"lb-km-aim","path":"/v1/sms/templates/{id}/variable","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-order":5,"x-request-examples-description-1":"查询ID为\"1512***3\"的模板变量列表。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/sms/templates/1512***3/variable","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"}