云服务器内容精选

  • 请求示例 修改短信模板,请求方式:PUT ,请求URL:/v2/{project_id}/msgsms/templates/{id},路径参数:id,project_id,请求头参数:X-Auth-Token,Content-Type,请求体:app_id,region,template_content,template_name,template_type。 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/c3f641aa-4e87-4a70-b84d-a2d685599072 HTTP/1.1 Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token: *** Content-Length: 311 { "app_id": "******9c-1a6b-4ee5-9651-5bca450694b3", "brackets": "GB", "region": "cn", "sign_id": "******58-e866-4b30-9ca5-a476a00e8775", "template_content": "测试", "template_name": "auto_test000", "template_type": "NOTIFY_TYPE", "universal_template": 0 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 是 String 应用主键ID,参考表5 响应SmsAppQueryResp参数中的id brackets 否 String 中括号类型。支持枚举值: CN:中文类型:【】 GB:英文类型: [] 须知: 默认值为:CN 输入值不在上述枚举值范围内的,也按CN处理。 只有地域为国内时,该字段有效。 region 是 String 地域 cn:国内 intl:国际 send_country 否 Array of Integers 发送国家id列表,只有地域为国际时,该字段有效 sign_id 否 String 签名id,对应表5 响应SmsSignatureResp参数中的ID。只有地域为国内时,该字段有效 template_content 是 String 模板内容 template_desc 否 String 模板描述 template_name 是 String 模板名称 template_type 是 String 模板类型。只有地域为国内时,该字段有效。支持枚举值: VERIFY_CODE_TYPE: 验证码类 PROMOTION_TYPE: 推广类 NOTIFY_TYPE: 通知类 universal_template 否 Integer 是否为通用模板 0: 非通用模板 1: 通用模板 variable_attributes 否 Array of SmsTemplateVariableAttrReq objects 模板参数 表4 SmsTemplateVariableAttrReq 参数 是否必选 参数类型 描述 variable_desc 否 String 变量说明,当变量类型为TEXT时,必填 variable_index 是 Integer 变量索引,对应模板内容变量索引 variable_type 是 String 变量类型,目前支持:PHONE|CHARDIGIT|DATETIME|MONEY|TEXT|NEWTEXT
  • 请求示例 批量删除主键ID为“******27-37eb-4229-bee9-0eba4d8a897f”和“******fe-8c9d-4cd2-9402-cd2fef488782”的模板。 POST https://{Endpoint}/v2/{project_id}/msgsms/templates/batch-delete { "ids" : [ "******27-37eb-4229-bee9-0eba4d8a897f", "******fe-8c9d-4cd2-9402-cd2fef488782" ] }
  • 响应示例 状态码: 200 OK { "success_count" : 1, "success_ids" : [ "******27-37eb-4229-bee9-0eba4d8a897f" ], "failed_count" : 1, "failed_template_list" : [ { "id" : "******fe-8c9d-4cd2-9402-cd2fef488782", "error_msg" : "Message Template Info does not EXIST" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 success_count Integer 成功删除的数量 最小值:0 最大值:50 success_ids Array of strings 成功删除的模板主键ID集合 最小长度:1 最大长度:64 数组长度:0 - 50 failed_count Integer 失败删除的数量 最小值:0 最大值:50 failed_template_list Array of SmsTemplateDeleteErrorInfo objects 模板删除失败信息列表 数组长度:0 - 50 表5 SmsTemplateDeleteErrorInfo 参数 参数类型 描述 id String 模板主键ID 最小长度:1 最大长度:64 error_msg String 模板删除失败信息 最小长度:1 最大长度:512 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误信息 最小长度:1 最大长度:512 error_detail String 描述 最小长度:1 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json;charset=utf8 缺省值:application/json;charset=utf8 最小长度:1 最大长度:255 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 否 Array of strings 模板主键ID集合 最小长度:1 最大长度:64 数组长度:1 - 50
  • 请求示例 查询模板变量,请求方式:GET ,请求URL:/v2/{project_id}/msgsms/templates/{id}/varilable,路径参数:id,project_id,请求头参数:X-Auth-Token,Content-Type。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/f063a294-06ab-420e-90bc-0c4dd9aed540/varilable Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******
  • 响应示例 { "results": [ { "id": 15003394, "temp_name": "测试", "variable_index": 1, "variable_type": "URL", "variable_length": 99, "variable_desc": "" } ], "total": 1 }
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 results Array of ApiTemplateVariable 查询结果 total Long 总数 表4 ApiTemplateVariable 参数 是否必选 参数类型 描述 id 否 Integer 变量id User_name 否 String 用户名 temp_name 否 String 模板名称 variable_index 否 Integer 变量索引 variable_type 否 String 变量类型 variable_length 否 Integer 变量长度 variable_desc 否 String 变量描述