调用该接口为应用添加域名。

限制说明

单阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateStudioAppDomainOpen

系统规定参数。取值：CreateStudioAppDomainOpen。
AppId String 是 a12*******

应用ID。可调用QueryStudioAppList查询。

Host String 是 www.aliyun.test.com

域名。
ProjectId String 是 a123******

项目ID。

1. 您可登录物联网应用开发控制台，在页面左上角选择对应实例后，在左侧导航栏单击项目管理。

2. 在普通项目列表中，找到目标项目，单击项目卡片，在地址栏中查看。
Protocol String 是 https

请求协议。

  • https
  • http
IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。

您可在物联网平台控制台的实例概览页面，查看当前实例的ID。若有ID值，必须传入该ID值，否则调用会失败。

说明 如果公共实例没有ID值，请参见如何获取实例ID。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。错误码详情，请参见错误码。

Data Struct

应用添加域名的详情。
AppId String a12******

应用ID。
Host String www.aliyun.test.com

域名。
Id Integer 1573

域名ID。
IsBeian String YES

域名是否已备案。

  • YES：是。
  • NO：否。
ProjectId String a12*******

项目ID。
Protocol String https

请求协议。
TenantId String C70B541046F64EAABE3*******

租户ID。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateStudioAppDomainOpen
&AppId=a12*******
&Host=www.aliyun.test.com
&ProjectId=a123******
&Protocol=https
&<公共请求参数>

正常返回示例

XML格式 

<CreateStudioAppDomainOpenResponse>    
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Data>
            <TenantId>C70B541046F64EAABE3*******</TenantId>
            <AppId>a12******</AppId>
            <ProjectId>a12*******</ProjectId>
            <Host>www.aliyun.test.com</Host>
            <Id>1573</Id>
            <Protocol>https</Protocol>
            <IsBeian>YES</IsBeian>
      </Data>
      <Success>true</Success>
</CreateStudioAppDomainOpenResponse>

JSON格式 

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "TenantId": "C70B541046F64EAABE3*******",
        "AppId": "a12******",
        "ProjectId": "a12*******",
        "Host": "www.aliyun.test.com",
        "Id": 1573,
        "Protocol": "https",
        "IsBeian": "YES"
    },
    "Success": true
}