华为云用户手册

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识，用于问题排查，建议保存。 job_id String 作业唯一标识。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

使用临时授权请求鉴权 开启公共读授权访问，虽然使用比较方便，但如果对于敏感的信息，例如个人的私有数据，存在泄露风险。此场景下，可以考虑OBS提供的临时授权功能。 OBS服务支持用户对OBS服务中的对象构造一个特定URL，URL中会包含鉴权信息，任何用户都可以通过该URL访问OBS中的对象，但该URL只在Expires指定的失效时间内有效。该方式用于在不提供给其他人Secret Access Key的情况下，让其他人能够执行自己定义的操作。 进一步了解和使用OBS临时授权功能，请参见《 对象存储服务 SDK参考》对应语言“授权访问”章节的相关内容，下载相关的SDK及示例代码，并进行相关的编码开发，以支持相关的URL获取。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。如果请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxx为project的name，获取方法请参见获取用户名、账号名和项目name。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 表3 公共请求消息头 名称 描述 是否必选 示例 X-Sdk-Date 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 否 使用AK/SK认证时必选。 20150907T101459Z Authorization 签名认证信息。 该值来源于请求签名结果。 否 使用AK/SK认证时必选。 SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。 是 application/json Content-Length 请求body长度，单位为Byte。 POST/PUT请求必填。 GET不能包含。 3495 X-Project-Id project id，用于不同project取token。 如果是DeC的请求或者多project的请求则必须传入project id。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 否 使用Token认证时必选。 - 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见API签名指南。 其它header属性，请遵照https协议。 例如，对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从终端节点中获取。 例如 IAM 服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。 从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如，您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识，用于问题排查，建议保存。 job_id String 作业唯一标识。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

响应示例 状态码： 200 成功响应示例 { "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48", "request_id" : "07490f57ac5e034c077ab25b5f9e1da5"} 状态码： 400 失败响应示例 { "error_code" : "AIS.0401", "error_msg" : "The input parameter event_type is incorrect."}

请求示例 创建音频流 内容审核 作业请求体 POST https://{endpoint}/v3/{project_id}/moderation/audio-stream/jobs{ "data" : { "url" : "https://xxxxx" }, "event_type" : "default", "categories" : [ "porn", "ad" ], "callback" : "http://xxxx"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 data 是 data object 音频流数据输入。 event_type 是 String 事件类型，可选值如下： default：默认事件 audiobook：有声书 education：教育音频 game：游戏语音房 live：秀场直播 ecommerce：电商直播 voiceroom：交友语音房 private：私密语音聊天 categories 是 Array of strings 需要检测的风险类型，列表不能为空。可选择的风险类型如下： porn：涉黄检测 abuse: 辱骂检测 ad: 广告检测 moan: 娇喘检测 callback 是 String 该字段非空时，检测结果会回调通知您的URL。音频流未结束时，检测片段违规时回调客户端，音频流结束时，检测片段违规或正常都将回调客户端。 说明： 您的callback接口需要支持POST方法； 回调数据格式，请参考查询音频内容审核作业的响应示例； 您的服务端callback接口收到内容安全发送的结果后，如果在响应超时时间3秒内返回的HTTP状态码为200，则表示接收成功。其他HTTP状态码或响应时间大于3秒后返回状态码均视为接收失败，接收失败时，内容安全将重复发送多次检测结果。 seed 否 String 用于回调通知时校验请求是由华为云内容安全服务发起，您可以自定义。值为随机字符串，由英文字母、数字、下划线组成，不超过64个字符。 说明： 当seed非空时，headers中将包含X-Auth-Signature字段，字段的值使用HmacSHA256算法生成，待加密字符串由create_time、job_id、request_id、seed按照顺序拼接而成，密钥为seed。 表4 data 参数 是否必选 参数类型 描述 url 是 String 音频流url地址，支持rtmp、rtmps、hls、http、https等主流协议。 language 否 String 支持检测的音频流语言。可选值为zh：中文。 不传该参数表示默认为zh。 return_all_results 否 Boolean 返回音频片段结果的策略。可选值如下： false：返回风险等级为非pass的音频片段结果。 true：返回所有风险等级的音频片段结果 说明： 1. 默认值为false。 2. 每隔10秒返回一次最近10秒音频流的审核结果。

状态码 状态码 编码 状态说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTPS的新版本协议。 200 OK 服务器已成功处理了请求。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Timeout 服务器等待请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request URI Too Long 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested Range Not Satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 Unprocessable Entity 请求格式正确，但是由于含有语义错误，无法响应。 429 Too Many Requests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 Gateway Timeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version Not Supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。 父主题： 附录

响应示例 状态码： 200 成功响应示例 { "request_id" : "xxxx", "job_id" : "xxx", "status" : "succeeded", "request_params" : { "data" : { "url" : "xxxx", "frame_interval" : 5 }, "event_type" : "default", "image_categories" : [ "porn", "terrorism", "image_text" ], "audio_categories" : [ "porn", "ad", "moan", "abuse" ], "callback" : "xxx" }, "create_time" : "2022-07-30T08:57:11.011Z", "update_time" : "2022-07-30T08:57:14.014Z", "result" : { "suggestion" : "block", "image_detail" : [ { "suggestion" : "block", "category" : "porn", "ocr_text" : "123", "time" : 0, "detail" : [ { "confidence" : 0.676015138626099, "category" : "porn", "suggestion" : "block", "label" : "pornography" }, { "confidence" : 0.666015138626099, "category" : "porn", "suggestion" : "review", "label" : "sexy_female" }, { "confidence" : 0.666015138626099, "category" : "xxx", "suggestion" : "block", "label" : "leader" }, { "confidence" : 0.691423773765564, "category" : "xxx", "suggestion" : "block", "face_location" : { "top_left_x" : 12, "top_left_y" : 13, "bottom_right_x" : 200, "bottom_right_y" : 240 }, "label" : "leader" }, { "confidence" : 0.691423773765564, "category" : "porn", "suggestion" : "block", "face_location" : { "top_left_x" : 12, "top_left_y" : 13, "bottom_right_x" : 100, "bottom_right_y" : 2000 }, "label" : "leader" }, { "confidence" : 0.891423773765564, "category" : "image_text", "suggestion" : "block", "label" : "qr_code" }, { "confidence" : 0.891423773765564, "category" : "image_text", "suggestion" : "block", "label" : "qr_code", "qr_content" : "xxxxxxxxx", "qr_location" : { "top_left_x" : 12, "top_left_y" : 13, "bottom_right_x" : 100, "bottom_right_y" : 2000 } }, { "confidence" : 0.891423773765564, "category" : "image_text", "suggestion" : "block", "label" : "porn", "segments" : [ { "segment" : "xxx" }, { "segment" : "xx" } ] } ] } ], "audio_detail" : [ { "suggestion" : "block", "label" : "porn", "audio_text" : "xxxxx", "end_time" : 10, "start_time" : 0, "detail" : [ { "confidence" : 0.999117187582349, "label" : "porn", "suggestion" : "block", "segments" : [ { "segment" : "xxx" } ] }, { "confidence" : 0.885117187582349, "label" : "porn", "suggestion" : "block" } ] } ] }} 状态码： 400 失败响应示例 { "error_code" : "AIS.0030", "error_msg" : "Job not found"}

请求示例 “endpoint”即调用API的请求地址，不同服务不同区域的endpoint不同，具体请参见终端节点。 例如，服务部署在“华北-北京四”区域的“endpoint”为“moderation.cn-north-4.myhuaweicloud.com”，请求URL为“https://moderation.cn-north-4.myhuaweicloud.com/v3/{project_id}/moderation/video/jobs/{job_id}”，“project_id”为项目ID，获取方法请参见获取项目ID，“job_id”为创建作业成功时，接口返回的job_id。 GET https://{endpoint}/v3/{project_id}/moderation/video/jobs/{job_id}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识，用于问题排查，建议保存。 job_id String 作业id。 status String 作业状态，可取值有： running: 正在运行 succeeded: 运行成功 failed: 运行失败 request_params request_params object 作业创建参数。 create_time String 作业创建时间。 update_time String 作业更新时间。 result result object 作业审核结果，当作业状态为succeeded时存在。 表4 request_params 参数 参数类型 描述 data data object 创建作业时传的data参数。 event_type String 创建作业时传的event_type参数。 image_categories Array of strings 创建作业时传的image_categories参数。 audio_categories Array of strings 创建作业时传的audio_categories参数。 callback String 创建作业时传的callback参数。 表5 data 参数 参数类型 描述 url String 创建作业时传的url参数。 frame_interval Integer 创建作业时传的frame_interval参数，默认为5秒截取一帧。 表6 result 参数 参数类型 描述 suggestion String 视频审核 结果是否通过。 block：包含敏感信息，不通过 review：需要人工复检 pass：不包含敏感信息，通过 image_detail Array of image_detail objects 图像审核 详情。 audio_detail Array of audio_detail objects 音频审核详情。 表7 image_detail 参数 参数类型 描述 suggestion String 图像审核结果是否通过。 block：包含敏感信息，不通过 review：需要人工复检 category String 检测结果的一级标签。 支持category列表如下： terrorism: 暴恐 porn: 色情 image_text: 图文审核 ocr_text String 图文审核检测出的文本，只有在category参数配置image_text且检测出文本时展示该字段。 time Float 截帧在视频文件中的时间，单位为秒。 detail Array of detail objects 图像帧审核详情。 表8 detail 参数 参数类型 描述 confidence Float 置信度，可选值在0-1之间，值越大，可信度越高。 category String 检测结果的一级标签。 支持category列表如下： terrorism: 暴恐 porn: 色情 image_text: 图文审核 suggestion String 审核结果是否通过。 block：包含敏感信息，不通过 review：需要人工复检 label String 识别的详细标签。 face_location face_location object 人物位置信息。 qr_location qr_location object 二维码位置信息。 qr_content String 图片中二维码指向的链接，当请求参数categories中包含image_text时存在。 segments Array of segments objects image_text场景下命中的文本片段。 表9 face_location 参数 参数类型 描述 top_left_x Integer 检测出人脸的左上角横坐标。 top_left_y Integer 检测出人脸的左上角纵坐标。 bottom_right_x Integer 检测出人脸的右下角横坐标。 bottom_right_y Integer 检测出人脸的右下角纵坐标。 表10 qr_location 参数 参数类型 描述 top_left_x Integer 检测出的二维码左上角横坐标。 top_left_y Integer 检测出的二维码左上角纵坐标。 bottom_right_x Integer 检测出的二维码右下角横坐标。 bottom_right_y Integer 检测出的二维码右下角纵坐标。 表11 segments 参数 参数类型 描述 segment String 命中的风险片段。 表12 audio_detail 参数 参数类型 描述 suggestion String 音频片段审核结果是否通过。 block：包含敏感信息，不通过 review：需要人工复检 label String 音频片段检测标签，选取detail中置信度最大的标签，可取值如下： terrorism: 暴恐 porn: 色情 ad: 广告 abuse: 辱骂 ban: 违禁 meaningless: 无意义 moan: 娇喘 audio_text String 音频片段文本内容。 end_time Float 音频片段结束时间。 start_time Float 音频片段开始时间。 detail Array of detail objects 音频片段审核详情。 表13 detail 参数 参数类型 描述 confidence Float 风险置信度。 label String 风险标签。 suggestion String 审核处理建议。 block：包含敏感信息，不通过 review：需要人工复检 segments Array of segments objects 命中的风险片段信息列表，如果命中语义算法模型，则该字段不会存在。 表14 segments 参数 参数类型 描述 segment String 命中的风险片段。 状态码： 400 表15 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

从控制台获取项目ID和名称 从控制台获取项目ID（project_id）和名称（project name）的步骤如下： 登录管理控制台。 在页面右上角单击用户名，然后在下拉列表中单击“我的凭证”，进入“我的凭证”页面。 如果您登录的是华为云官网，而非管理控制台。在单击用户名后，选择下拉列表中的“账号中心”，然后单击“管理我的凭证”进入“我的凭证”页面。 在“API凭证”页面的项目列表中查看项目ID和名称（即“项目”）。 图1 查看项目ID 多项目时，展开“所属区域”，从“项目ID”列获取子项目ID。

调用API获取项目ID 项目ID通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为GET https://{iam-endpoint}/v3/projects，其中{iam-endpoint}为IAM的终端节点，可以从地区和终端节点处获取。 响应示例如下，例如ModelArts部署的区域为"cn-north-4"，响应消息体中查找“name”为"cn-north-4"，其中projects下的“id”即为项目ID。 {"projects": [{"domain_id": "65382450e8f64ac0870cd180d14e684b","is_domain": false,"parent_id": "65382450e8f64ac0870cd180d14e684b","name": "cn-north-4","description": "","links": {"next": null,"previous": null,"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"},"id": "a4a5d4098fb4474fa22cd05f897d6b99","enabled": true}],"links": {"next": null,"previous": null,"self": "https://www.example.com/v3/projects"}}

错误码说明 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时，可以联系华为云客服，并提供错误码，以便尽快帮您解决问题。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 当您调用API时，如果遇到“APIG”开头的错误码，请参见APIG错误码。 状态码 错误码 错误信息 描述 处理措施 400 AIS.0002 The authentication token is abnormal. 验证Token异常。 请检查Token是否正确。 400 AIS.0003 Failed to complete the request because of an internal service error. 服务内部错误。 请联系华为云支持人员，请通过工单联系我们。 400 AIS.0004 The request is unauthorized. 无权限操作。 服务未开通请开通服务。服务开通请参见《内容审核快速入门》。 400 AIS.0005 The service does not exist. 服务不存在。 请检查传入的服务类型或场景是否正确，如果无法解决请联系华为云支持人员，请通过工单联系我们。 400 AIS.0007 The service has not been enabled yet. 服务未开通。 请开通服务。开通步骤请参考开通服务步骤说明。 400 AIS.0010 The header is missing or left empty. 缺少Header或者Header为空。 HTTP请求缺少必须的header信息，请检查是否有Content-type等必须字段。 400 AIS.0011 Lack the request parameter, or the request parameter is empty. 缺少请求参数或者参数为空。 请检查请求body是否缺少必须字段，请参考对应API的请求说明。 400 AIS.0012 The request parameter is not supported. 请求参数不支持。 请检查请求中的字段不合法，请参考对应API的请求说明。 400 AIS.0013 The request method is not allowed. 请求方法不允许。 请检查请求方法是否正确。 400 AIS.0014 The JSON format of the input data is incorrect. 输入数据JSON格式错误。 请检查输入数据的JSON格式。 400 AIS.0015 Base64 decoding of the input data is incorrect. 输入数据BASE64解码错误。 图片的Base64编码错误，请检查Base64内容。 400 AIS.0020 The size of the request body exceeds the upper limit. 请求体大小超过限制。 请检查请求体大小。 400 AIS.0021 The requested file type is not supported. 请求的文件类型不支持。 请检查请求的文件类型。 400 AIS.0022 The URL is invalid. URL不合法。 请检查输入的url格式。 400 AIS.0023 The file stored in OBS is oversized. 存储在OBS上的文件过大。 检查图片格式是否是服务支持的格式。具体请参见《内容审核使用限制》。 400 AIS.0024 Failed to obtain the file from OBS. 从OBS上获取文件失败。 原因可能为签名过期或签名验证未通过等。 400 AIS.0025 The file stored in OBS is empty. 存储在OBS上的文件为空。 请先上传文件到OBS上。 400 AIS.0026 Incorrect token type. token类型错误。 应使用project类型的token。 400 AIS.0027 The account has been frozen. 此账户已被冻结。 请检查是否账户是否欠费。 400 AIS.0028 The job is not owned by the current user. 此任务不属于当前用户。 请检查当前账户。 400 AIS.0029 Failed to download the file from the Internet. 从外网下载文件失败。 检查文件url是否正确以及是否在支持的范围内。 400 AIS.0030 Job not found 任务未找到。 任务已过期被清理了或者传入的job id错误。请检查job id是否正确。 400 AIS.0031 The maximum number of uncompleted jobs has been reached. 未处理完的任务总数达到限制。 暂停提交新任务。 400 AIS.0032 The monthly free calls have been used up. 月免费调用量已使用完。 如需继续使用给关联的华为云账户充值即可。 400 AIS.0501 Check whether the request JSON is abnormal. 检查请求json是否存在异常。 请求参数不是json格式。 400 AIS.0502 Check whether the Base64 encoding and URL of the image are correct. 检查图像base64以及url是否正确。 请检查图片base64编码是否正常，检查图片格式是否是服务支持的格式。 400 AIS.0504 The image size does not meet requirements. 图像大小不符合要求。 请检查图像大小是否符合服务限制。 400 AIS.0401 The input parameter is incorrect. 输入参数有误。 请输入正确的参数。 400 AIS.0402 The image format is not supported. 图片格式不支持。 检查图片格式是否是服务支持的格式。 400 AIS.0403 The image file has been damaged. 图片文件已损坏。 请重新上传图片文件。 400 AIS.0404 An exception occurs in Content Moderation . 内容审核处理错误。 请联系华为云支持人员，请通过工单联系我们。 400 AIS.0405 An internal error occurs. 内部错误。 请联系华为云支持人员，请通过工单联系我们。 400 AIS.0039 Repetitive push stream. 重复推流，重复创建审核作业。 如果没有回调预期的审核结果，对该流创建审核作业又提示重复推流，您可以关闭该审核作业，然后对该流重新创建审核作业。 400 APIG.0101 The API does not exist or has not been published. 您所访问的API不存在或尚未在环境中发布。 请检查输入的api信息是否正确，是否该服务存在对应的区域中。检查API的URL是否拼写正确，HTTP请求方法（POST，GET等）是否正确，请检查服务调用配置的域名和uri信息是否正确，域名可参考域名。 400 APIG.0301 1. Incorrect IAM authentication information: Failed to decrypt the token. Check whether the entered token is complete. 2. The validity period of a token is 24 hours. If the token expires, obtain a new token and pass it. 3. The AK/SK authentication fails. Check whether the AK/SK is correct and whether the account is restricted due to arrears. 1.IAM身份验证信息不正确：解密令牌失败，检查输入的token是否完整。 2.token有效期为24小时，token超时，重新传入获取token值。 3.因为AK/SK认证失败，请检查AK/SK是否正确，账号是否因欠费等原因权限被限制。 decrypt token fail：发送的HTTP请求header中x-auth-token的token请求认证信息错误，请检查发送的请求和token。 token expires：token超时，请重新获取新token传入。 verify aksk signature fail：请检查AK、SK是否正确，账号是否欠费。 400 APIG.0201 The request body is oversized. 请求体过大。 请检查请求的body体是否过大，具体请参见《内容审核使用限制》，进行调整。 400 APIG.0308 The request is sent too fast and exceeds the default rate limit of the service. 请求发送太快，超过了服务的默认配置限流。 请求发送太快，达到了API的限速阈值，请降低请求速度。如有更高请求速度要求，请联系华为云支持人员，请通过工单联系我们。 400 ModelArts.0203 Invalid token. 非法Token。 请检查Token是否正确。 400 ModelArts.4101 The token is empty. Token为空。 发送的HTTP请求header中没有带x-auth-token的token请求认证信息，请检查发送的请求。 400 ModelArts.4102 Failed to parse the token. 解析Token失败。 发送的HTTP请求header中x-auth-token的token请求认证信息错误，请检查发送的请求和token。 400 ModelArts.4103 The token is invalid. Token不合法。 发送的HTTP请求header中x-auth-token的token请求认证信息错误，请检查发送的请求和token。 400 ModelArts.4104 The length of the request body is invalid. 请求body体长度不合法。 请检查请求body体长度。 400 ModelArts.4105 The JSON format of the request body is incorrect. 请求body体json格式不对。 请检查请求body体是否符合json格式。 400 ModelArts.4106 The account is restricted. 用户账号受限。 请检查用户资源状态，账号受限原因请参考账号中心相关描述。 400 ModelArts.4107 An exception occurred when obtaining the temporary AK/SK. 获取用户临时AK，SK异常。 请联系华为云支持人员，通过工单联系我们。 400 ModelArts.4201 The request URL does not contain the service ID. 请求url中需要包含服务ID。 请检查请求url中的服务ID。 400 ModelArts.4202 The request URL format is invalid. 请求url格式不合法。 请检查请求url格式。 400 ModelArts.4203 No access permission. 没有权限访问。 请检查访问权限。 400 ModelArts.4204 Request api error! The API is not subscribed. 没有订阅该API。 请订阅该API，订阅API请参考服务介绍开通申请服务。如已开通服务，请检查开通服务的区域与服务调用的一致，如果一致请检查API的URL是否拼写正确，HTTP请求方法（POST，GET等）是否正确。 400 ModelArts.4601 The external URL is invalid. 外网下载地址不合法。 请检查输入的url下载地址参数格式。 400 ModelArts.4603 The file failed to be downloaded from the external URL. 下载外网URL文件失败。 请检查输入的url是否可下载。 400 ModelArts.4702 The OBS agency failed to be queried. 查询OBS委托失败。 请检查是否已开通给服务的OBS委托。 400 ModelArts.4703 The OBS URL is invalid. OBS地址不合法。 请检查输入的OBS的url地址。 400 ModelArts.4704 Failed to obtain the OBS file. 获取OBS文件失败。 下载OBS文件失败，请检查对应的文件是否存在。 400 ModelArts.4705 The OBS file is oversized. OBS文件大小超限。 请使用符合服务大小限制的文件作为输入，具体请参见《内容审核使用限制》。 400 ModelArts.4706 The OBS file does not exist. OBS文件不存在。 下载OBS文件失败，请检查对应的文件是否存在。 400 其他 如果出现其他无法解决的错误码，请通过工单联系我们。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 username、domainname 的获取请参考获取账号名和账号ID。password为用户密码。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

AK/SK认证 AK/SK签名认证、Token认证方式仅支持消息体大小12M以内的请求使用。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，“error_code”表示错误码，“error_msg”表示错误描述信息。

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区（Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 父主题： 使用前必读

响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 表1 响应消息头 名称 描述 Content-Length 响应消息体的字节长度，单位为Byte。 Date 系统响应的时间。 Content-Type 响应消息体的MIME类型。 对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头

响应示例 状态码： 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常"} 示例 2 { "error_code" : "GSL.00027001", "error_msg" : "自定义属性名称不合法，请检查！"} 示例 3 { "error_code" : "GSL.00027002", "error_msg" : "自定义属性名称已存在，请重新输入！"} 示例 4 { "error_code" : "GSL.00027003", "error_msg" : "自定义属性名称和SIM卡管理列字段重复，请重新输入！"} 示例 5 { "error_code" : "GSL.00027004", "error_msg" : "登录用户最多可以创建6个自定义属性。"} 状态码： 500 Internal Server Error { "error_code" : "GSL.00020003", "error_msg" : "系统繁忙，请稍后重试。"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 - Boolean OK 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作类型(ADD：断网，DEL:取消断网) 最大长度：10 iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理 最小长度：19 最大长度：20

响应示例 状态码： 200 OK { "work_order_id" : 1000001} 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常"} 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 创建SIM卡断网/恢复在用的申请，将sim_card_id对应的SIM卡操作断网。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/cut-net{ "action" : "ADD"} 创建SIM卡断网/恢复在用的申请。当参数sim_card_id为最小值时，将卡标识iccid为“898600xxxxxxxxxx”的SIM卡操作断网。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/cut-net{ "action" : "ADD", "iccid" : "898600xxxxxxxxxx"}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表2 请求Body参数 参数 是否必选 参数类型 描述 template_id 否 Long 模板id sms_content 是 String 短信内容 最大长度：1000 cids 否 Array of strings 容器ID order_id 否 Long 批次号 file_temp_id 否 Long 临时文件ID

请求示例 发送短信，如：发送短信给cids集合里面的SIM卡“89861xxxxxxxxxxx”和“89862xxxxxxxxxxx”，短信内容sms_content为“测试”。 POST https://{endpoint}/v1/sms-send-infos{ "sms_content" : "测试", "cids" : [ "89861xxxxxxxxxxx", "89862xxxxxxxxxxx" ]}