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":{"SignaturePageQueryResponse":{"properties":{"results":{"description":"查询结果","items":{"$ref":"#/definitions/SmsSignatureResp"},"maxItems":10000,"minItems":0,"type":"array"},"total":{"description":"总数","example":1,"format":"int64","maximum":2147483647,"minimum":0,"type":"integer"}},"title":"SignaturePageQueryResponse","type":"object"},"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"},"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":"71e9f2a1479a4dd4b3c06ee1d070b091","info_version":"v2","method":"get","name":"ListSignatureDetails","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":{"get":{"deprecated":false,"description":"该接口用于用户查询已创建的短信签名信息。","operationId":"ListSignatureDetails","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/Content-Type"},{"$ref":"#/parameters/project_id"},{"description":"应用名称","in":"query","maxLength":64,"minLength":1,"name":"app_name","required":false,"type":"string","x-example":"auto_test789"},{"description":"开始时间","in":"query","maxLength":20,"minLength":1,"name":"start_time","required":false,"type":"string","x-example":"2023-03-14 08:21:48"},{"description":"结束时间","in":"query","maxLength":20,"minLength":1,"name":"end_time","required":false,"type":"string","x-example":"2023-03-15 08:21:48"},{"default":10,"description":"数量","format":"int32","in":"query","maximum":500,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":10},{"default":0,"description":"偏移量","format":"int32","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer","x-example":0},{"description":"签名ID","in":"query","maxLength":64,"minLength":1,"name":"signature_id","required":false,"type":"string","x-example":"07cfacbb-d48c-4c4d-b3da-baa8e4664852"},{"description":"签名名称","in":"query","maxLength":32,"minLength":1,"name":"signature_name","required":false,"type":"string","x-example":"auto_test7890"},{"description":"签名类型。支持枚举值:\n1. VERIFY_CODE_TYPE: 验证码类\n2. PROMOTION_TYPE: 推广类\n3. NOTIFY_TYPE: 通知类","in":"query","maxLength":64,"minLength":1,"name":"signature_type","required":false,"type":"string","x-example":"NOTIFY_TYPE"},{"description":"地域","in":"query","maxLength":16,"minLength":1,"name":"site","required":false,"type":"string","x-example":"cn"},{"description":"排序方式\n1. desc:降序\n2. asc:升序","in":"query","maxLength":20,"minLength":1,"name":"sort_dir","required":false,"type":"string","x-example":"desc"},{"description":"排序字段","in":"query","maxLength":64,"minLength":1,"name":"sort_key","required":false,"type":"string","x-example":"create_time"},{"description":"状态\n1. PENDING_REVIEW:待审核\n2. PROCESSING:内容审核通过,签名处理中\n3. REVIEW_PASSED:处理完毕\n4. REVIEW_NOT_PASS:审核不通过\n5. TO_BE_ACTIVATED:待激活\n6. PENDING_ACTIVATE:激活审核中","in":"query","maxLength":32,"minLength":1,"name":"status","required":false,"type":"string","x-example":"PENDING_REVIEW"}],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SignaturePageQueryResponse"}},"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"}