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":{"SmsAppQueryResp":{"properties":{"app_access_addr":{"description":"接入地址","example":"https://100.**.***.**:8443","maxLength":256,"minLength":1,"type":"string"},"app_key":{"description":"应用key","example":"******3baZf4c856O4Qrbqvui3K2","maxLength":128,"minLength":1,"type":"string"},"app_name":{"description":"应用名称","example":"auto_test789","maxLength":64,"minLength":1,"type":"string"},"create_time":{"description":"创建时间[yyyy-MM-dd HH:mm:ss]","example":"2022-08-12 06:51:17","maxLength":20,"minLength":1,"type":"string"},"customer_id":{"description":"租户customer id","example":"******c55c3c4526b2ed7a0213bc9871","maxLength":64,"minLength":1,"type":"string"},"developer_account":{"description":"租户开发者账号","example":"****66_sms","maxLength":64,"minLength":1,"type":"string"},"enterprise_project_id":{"description":"企业项目ID","example":"0","maxLength":64,"minLength":1,"type":"string"},"enterprise_project_name":{"description":"企业项目名称","example":"default","maxLength":255,"minLength":1,"type":"string"},"id":{"description":"应用主键ID,用于获取、修改应用的唯一标识","example":"9e61f59c-1a6b-4ee5-9651-5bca450694b3","maxLength":64,"minLength":1,"type":"string"},"industry":{"description":"行业类型","example":14,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"intl_channel_num":{"description":"国际/港澳台短信通道号","example":"******886739","maxLength":32,"minLength":1,"type":"string"},"ip_white_list":{"description":"IP白名单","example":"auto_test789","maxLength":4096,"minLength":0,"type":"string"},"is_support_multiomp":{"description":"是否支持多OMP","example":false,"type":"boolean"},"omp_app_name":{"description":"omp应用名称","example":"******4877bf46b5906a3240636bc7aa","maxLength":48,"minLength":1,"type":"string"},"platform":{"description":"平台","example":"NFV","maxLength":32,"minLength":1,"type":"string"},"protocol":{"description":"协议","example":"https","maxLength":10,"minLength":1,"type":"string"},"region":{"description":"地域\n1. cn:国内\n2. intl:国际","example":"cn","maxLength":16,"minLength":1,"type":"string"},"resource_id":{"description":"租户resource id","example":"******8a-a690-4e14-a1c7-2430937336d0","maxLength":64,"minLength":1,"type":"string"},"status":{"description":"应用状态\n  CREATED:待上线。应用暂未创建成功,请稍候。\n  SUSPENDED:暂停。无法发起业务请求。当客户所发短信内容触发业务违规,或客户申请退订短信业务时,运营经理会将客户短信应用暂停。\n  LAUNCHED:正常。应用添加成功,可以正常使用。","example":"LAUNCHED","maxLength":32,"minLength":1,"type":"string"},"tenant":{"$ref":"#/definitions/TenantBasic"},"up_link_addr":{"description":"上行短信地址","example":"https://localhost/uplinkaddr","maxLength":128,"minLength":1,"type":"string"},"update_time":{"description":"更新时间[yyyy-MM-dd HH:mm:ss]","example":"2022-08-12 06:51:17","maxLength":20,"minLength":1,"type":"string"}},"title":"SmsAppQueryResp"},"TenantBasic":{"properties":{"customer_id":{"description":"租户custom id","example":"******c55c3c4526b2ed7a0213bc9871","maxLength":64,"minLength":1,"type":"string"},"customer_name":{"description":"租户custom name","example":"****05","maxLength":128,"minLength":1,"type":"string"},"enterprise_name":{"description":"租户企业名称","example":"华为技术有限公司","maxLength":128,"minLength":1,"type":"string"}},"title":"TenantBasic","type":"object"}},"description":null,"group_id":"6ec12426d3234d80b6da21f8367b6607","host":"msgsms.cn-north-4.myhuaweicloud.com","id":"a2f901a500eb40b5b0c79576b9e3a688","info_version":"v2","method":"get","name":"ShowApp","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}":{"get":{"deprecated":false,"description":"该接口用于用户查询应用详情信息。","operationId":"ShowApp","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"}],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SmsAppQueryResp"}},"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.ADD, resource = \"console.root.message.app\", requireLog = true, source = SourceType.API)","@RestrictCheck(serviceType = \"hws.service.type.rtcsms\", restrictScene = {TENANT_RESTRICT, 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"}