huawei-cloud-api-definitions-MSGSMS 0.1.20250110

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"SmsSignatureResp":{"properties":{"app_key":{"description":"应用key","example":"******3baZf4c856O4Qrbqvui3K2","maxLength":128,"minLength":0,"type":"string"},"app_name":{"description":"应用名称","example":"auto_test7890","maxLength":64,"minLength":1,"type":"string"},"apply_desc":{"description":"申请描述","example":"test","maxLength":300,"minLength":0,"type":"string"},"channel_num":{"description":"国内短信通道号,仅当签名审核成功,运营人员配置完成后返回。","example":"******1733968","maxLength":32,"minLength":1,"type":"string"},"create_time":{"description":"创建时间[yyyy-MM-dd HH:mm:ss]","example":"2022-08-12 07:14:18","maxLength":20,"minLength":1,"type":"string"},"customer_id":{"description":"租户customer id","example":"******c55c3c4526b2ed7a0213bc9871","maxLength":64,"minLength":1,"type":"string"},"file_id":{"description":"文件id","example":"******ab-1390-4268-9463-73db98cdc2e1","maxLength":64,"minLength":1,"type":"string"},"id":{"description":"签名主键id,用于获取、修改、删除、申请激活签名的唯一标识","example":"******bb-d48c-4c4d-b3da-baa8e4664852","maxLength":64,"minLength":1,"type":"string"},"is_involved_third":{"description":"是否涉及第三方权益","example":"No","maxLength":16,"minLength":1,"type":"string"},"power_attorney_file_id":{"description":"授权委托书文件ID","example":"******ab-1390-4268-9463-73db98cdc2e2","maxLength":128,"minLength":1,"type":"string"},"qualification_id":{"description":"资质ID","example":"******d1-4dd9-98a1-47607a5655ce","maxLength":64,"minLength":0,"type":"string"},"qualification_name":{"description":"资质名","example":"******name","maxLength":32,"minLength":0,"type":"string"},"review_desc":{"description":"审核意见","example":"test","maxLength":300,"minLength":0,"type":"string"},"signature_id":{"description":"签名id","example":"******d1-196f-495f-abbe-42240469b8fc","maxLength":64,"minLength":1,"type":"string"},"signature_name":{"description":"签名名称","example":"auto_test789","maxLength":32,"minLength":1,"type":"string"},"signature_source":{"description":"签名来源","example":0,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"signature_type":{"description":"签名类型","example":"NOTIFY_TYPE","maxLength":64,"minLength":1,"type":"string"},"signature_usage":{"description":"签名用途","example":"COMMERCIAL","maxLength":32,"minLength":1,"type":"string"},"site":{"description":"站点","example":"cn","maxLength":16,"minLength":1,"type":"string"},"source_title_content":{"description":"标题内容","example":"test","maxLength":512,"minLength":0,"type":"string"},"status":{"description":"签名状态","example":"PENDING_REVIEW","maxLength":64,"minLength":1,"type":"string"},"tenant":{"$ref":"#/definitions/TenantBasic"},"update_time":{"description":"更新时间[yyyy-MM-dd HH:mm:ss]","example":"2022-08-12 07:14:18","maxLength":20,"minLength":1,"type":"string"},"urge_desc":{"description":"催审描述","example":"test","maxLength":500,"minLength":0,"type":"string"},"urge_status":{"description":"催审状态","example":"No","maxLength":8,"minLength":1,"type":"string"},"urge_time":{"description":"催审时间","example":"2022-08-12 07:14:18","maxLength":20,"minLength":1,"type":"string"}},"title":"SmsSignatureResp"},"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":"f13e831635c8495ab909fc9053d7a2ca","info_version":"v2","method":"get","name":"ShowSignature","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/signatures/{id}":{"get":{"deprecated":false,"description":"该接口用于用户查询签名详情信息。","operationId":"ShowSignature","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":"07cfacbb-d48c-4c4d-b3da-baa8e4664852"}],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SmsSignatureResp"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"schemes":["https"],"summary":"获取签名详情","tags":["SignatureManagement"],"x-api-type":"open-api","x-imports":["com.huawei.cloud.common.operation.*;","com.huawei.cloud.common.log.SourceType;"],"x-internal":false,"x-is-registered":"Y","x-methodAnnotations":["@Operation(name = \"获取签名详情\", action = OperateType.QUERY, resource = \"console.root.message.signatures\", requireLog = true, source = SourceType.API)"],"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"}