huawei-cloud-api-definitions-MSGSMS 0.1.20240201

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"SmsAppUpdateReq":{"properties":{"app_name":{"description":"应用名称","example":"auto_test7890","maxLength":64,"minLength":1,"type":"string","x-annotations":"@NotBlank"},"create_sign_and_template":{"description":"是否创建测试签名和模板。只有地域为国内时,该字段有效\n1. true:是\n2. false:否","example":false,"type":"boolean"},"enterprise_project_id":{"description":"企业项目ID,默认为0","example":"0","maxLength":64,"minLength":1,"type":"string"},"enterprise_project_name":{"description":"企业项目名称,默认为default","example":"default","maxLength":255,"minLength":1,"type":"string"},"region":{"description":"地域\n1. cn:国内\n2. intl:国际","example":"cn","maxLength":16,"minLength":1,"type":"string","x-annotations":["@NotBlank","@JsonAlias({\"location\", \"region\"})"]},"up_link_addr":{"description":"上行回调地址。只有地域为国内时,该字段有效","example":"https://localhost/callback","maxLength":128,"minLength":0,"type":"string"}},"required":["app_name","region"],"title":"SmsAppUpdateReq","x-imports":"com.fasterxml.jackson.annotation.JsonAlias;"},"SmsUpdateAppResp":{"properties":{"app_key":{"description":"应用KEY","example":"******3baZf4c856O4Qrbqvui3K2","maxLength":128,"minLength":1,"type":"string"},"app_name":{"description":"应用名称","example":"auto_test789","maxLength":64,"minLength":1,"type":"string"},"id":{"description":"应用主键ID","example":"9e61f59c-1a6b-4ee5-9651-5bca450694b3","maxLength":64,"minLength":1,"type":"string"}},"title":"SmsUpdateAppResp"}},"description":null,"group_id":"6ec12426d3234d80b6da21f8367b6607","host":"msgsms.cn-north-4.myhuaweicloud.com","id":"9cb93e784afb40f7ad3bf32cec17c4b6","info_version":"v2","method":"put","name":"UpdateApp","parameters":{"Content-Type":{"default":"application/json;charset=utf8","description":"请求体参数类型,该字段必须设置为:application/json;charset=utf8","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":true,"type":"string","x-example":"application/json;charset=utf8"},"X-Auth-Token":{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)","in":"header","maxLength":32768,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"******JKoZIhvcNAQcCoIIDgzCCXXXXX"},"project_id":{"description":"项目ID。获取方法请参见 [获取帐号、用户、项目的名称和ID](https://support.huaweicloud.com/api-msgsms/sms_05_0020.html)。","in":"path","name":"project_id","pattern":"^[a-fA-F0-9]{1,32}$","required":true,"type":"string","x-example":"******c55c3c4526b2ed7a0213bc9871"}},"paths":{"/v2/{project_id}/msgsms/apps/{id}":{"put":{"consumes":["application/json"],"deprecated":false,"description":"该接口用于用户修改应用信息。","operationId":"UpdateApp","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/Content-Type"},{"$ref":"#/parameters/project_id"},{"description":"应用主键ID","in":"path","maxLength":64,"minLength":1,"name":"id","required":true,"type":"string","x-example":"9e61f59c-1a6b-4ee5-9651-5bca450694b3"},{"description":"请求Body参数","in":"body","name":"UpdateAppRequestBody","required":true,"schema":{"$ref":"#/definitions/SmsAppUpdateReq"}}],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SmsUpdateAppResp"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"schemes":["https"],"summary":"修改短信应用","tags":["AppManagement"],"x-api-type":"open-api","x-imports":["com.huawei.cloud.common.RestrictCheck;","com.huawei.cloud.common.operation.*;","com.huawei.cloud.common.log.SourceType;","static com.huawei.cloud.common.restrictcheck.RestrictFrozenType.*;"],"x-internal":false,"x-is-registered":"Y","x-methodAnnotations":["@Operation(name = \"用户修改短信应用\", action = OperateType.UPDATE, resource = \"console.root.message.app\", requireLog = true, source = SourceType.API)","@RestrictCheck(serviceType = \"hws.service.type.rtcsms\", restrictScene = {TENANT_FROZEN, SERVICE_FROZEN})"],"x-service":"messageService","x-support-sdk":"Y"}}},"product_short":"MSGSMS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"修改短信应用","tags":"短信应用API","uri":null,"version":"2.0"}