更新定制模型

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

const columns = [
  {
    width: '20%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name'
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: 90,
    title: '是否必填',
    dataIndex: 'IsRequired',
    className: 'openapi-doc-parameter-table-required'
  },
  {
    width: '20%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const data = [
  {
    rowKey: '->Action',
    Name: 'Action',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"UpdateCustomModel"} />,
    Description: <RenderMd content={"要执行的操作，取值：UpdateCustomModel。"} />,
    children: [
    ]
  },
  {
    rowKey: '->Version',
    Name: 'Version',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"2024-01-01"} />,
    Description: <RenderMd content={"API的版本，取值：2024-01-01。"} />,
    children: [
    ]
  },
  {
    rowKey: '->Id',
    Name: 'Id',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"cm-id"} />,
    Description: <RenderMd content={"定制模型的ID"} />,
    children: [
    ]
  },
  {
    rowKey: '->Name',
    Name: 'Name',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={"TestName"} />,
    Description: <RenderMd content={"定制模型名称"} />,
    children: [
    ]
  },
  {
    rowKey: '->Description',
    Name: 'Description',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={"TestDescription"} />,
    Description: <RenderMd content={"定制模型描述"} />,
    children: [
    ]
  },
  {
    rowKey: '->DryRun',
    Name: 'DryRun',
    DataType: 'Boolean',
    IsRequired: '否',
    Example: <RenderMd content={"true"} />,
    Description: <RenderMd content={"是否仅对此请求进行预检。取值：\n- true：发送检查请求。\n- false(默认)：发送正常请求"} />,
    children: [
    ]
  },

];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

const columns = [
  {
    width: '25%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name',
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: '25%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const data = [
  {
    rowKey: "->Id",
    Name: "Id",
    DataType: "String",
    Example: <RenderMd content={"cm-id"} />,
    Description: <RenderMd content={"资源的ID"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

请求示例

POST /?Action=UpdateCustomModel&Version=2024-01-01 HTTP/1.1
Host: ark.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240514T130759Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240514/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Id": "cm-id",
  "Name": "TestName",
  "Description": "TestDescription",
  "DryRun": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240514210804240055238131D7DFB2",
    "Action": "UpdateCustomModel",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": "cm-id"
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。