文档中心 > API类目 > 书旗内容文巢

alibaba.shuqi.original.copyright.cpapi.getcpapilist (渠道配置接口列表)

渠道配置接口列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
version_id Number 可选 1 versionId
online_id Number 可选 1 onlineId
id Number 可选 1 id
uri String 可选 1 uri
channel_id Number 可选 1 channelId
dispose_id Number 可选 1 disposeId

响应参数

名称 类型 示例值 描述
result CommonResponse 1 result
  • data
  • OgnvFieldQueryResp
  • 1
  • data
  • ognv_cp_interface_list
  • OgnvCpInterfaceDto []
  • 1
  • ognvCpInterfaceList
  • └ resp_type
  • Number
  • 1
  • respType
  • └ cr_time
  • Number
  • 1626427609
  • crTime
  • └ enable_state
  • Number
  • 1
  • enableState
  • req_templates
  • ReqTemplate []
  • 1
  • reqTemplate
  • └ check_condition_key_fields
  • String []
  • 1
  • checkConditionKeyField
  • └ target_field_type
  • Number
  • 1
  • targetFieldType
  • └ default_value
  • String
  • 1
  • defaultValue
  • └ check_condition
  • String
  • 1
  • checkCondition
  • └ covert_rule_key_fields
  • String []
  • 1
  • covertRuleKeyField
  • └ req_field_type
  • Number
  • 1
  • reqFieldType
  • └ check_condition_json
  • String
  • 1
  • checkConditionJson
  • └ convert_rule_json
  • String
  • 1
  • convertRuleJson
  • └ convert_rule
  • String
  • 1
  • convertRule
  • └ target_field_name
  • String
  • chapterOrd
  • targetFieldName
  • └ rule_id
  • Number
  • demo
  • ruleId
  • └ req_field_must
  • Number
  • 1
  • reqFieldMust
  • └ req_field_name
  • String
  • cdsv
  • reqFieldName
  • └ field_id
  • Number
  • 111
  • fieldId
  • └ req_method
  • Number
  • 2
  • reqMethod
  • └ description
  • String
  • demo
  • description
  • └ pub_state
  • Number
  • 1
  • pubState
  • └ uri
  • String
  • /grgiw/fweg
  • uri
  • └ up_time
  • Number
  • 1626427619
  • upTime
  • resp_templates
  • RespTemplate []
  • 1
  • respTemplate
  • └ level
  • Number
  • 1
  • level
  • └ target_field_type
  • Number
  • 1
  • targetFieldType
  • └ default_value
  • String
  • 22
  • defaultValue
  • └ covert_rule_key_fields
  • String []
  • 1
  • covertRuleKeyField
  • └ convert_rule_json
  • String
  • 1
  • convertRuleJson
  • └ resp_field_type
  • Number
  • 0
  • respFieldType
  • └ convert_rule
  • String
  • 1
  • convertRule
  • └ sub_template_keys
  • String []
  • 1
  • subTemplateKey
  • sub_templates
  • RespTemplateg []
  • 1
  • subTemplate
  • └ level
  • Number
  • 1
  • level
  • └ target_field_type
  • Number
  • 1
  • targetFieldType
  • └ default_value
  • String
  • 22
  • defaultValue
  • └ covert_rule_key_fields
  • String []
  • 1
  • covertRuleKeyField
  • └ convert_rule_json
  • String
  • 1
  • convertRuleJson
  • └ resp_field_type
  • Number
  • 0
  • respFieldType
  • └ convert_rule
  • String
  • 1
  • convertRule
  • └ sub_template_keys
  • String []
  • 1
  • subTemplateKey
  • sub_templates
  • RespTemplateg []
  • 1
  • subTemplate
  • └ level
  • Number
  • 1
  • level
  • └ target_field_type
  • Number
  • 1
  • targetFieldType
  • └ default_value
  • String
  • 22
  • defaultValue
  • └ covert_rule_key_fields
  • String []
  • 1
  • covertRuleKeyField
  • └ convert_rule_json
  • String
  • 1
  • convertRuleJson
  • └ resp_field_type
  • Number
  • 0
  • respFieldType
  • └ convert_rule
  • String
  • 1
  • convertRule
  • └ sub_template_keys
  • String []
  • 1
  • subTemplateKey
  • sub_templates
  • RespTemplateg []
  • 1
  • subTemplate
  • └ level
  • Number
  • 1
  • level
  • └ target_field_type
  • Number
  • 1
  • targetFieldType
  • └ default_value
  • String
  • 22
  • defaultValue
  • └ covert_rule_key_fields
  • String []
  • 1
  • covertRuleKeyField
  • └ convert_rule_json
  • String
  • 1
  • convertRuleJson
  • └ resp_field_type
  • Number
  • 0
  • respFieldType
  • └ convert_rule
  • String
  • 1
  • convertRule
  • └ sub_template_keys
  • String []
  • 1
  • subTemplateKey
  • └ sub_templates
  • String []
  • 1
  • subTemplate
  • └ resp_field_name
  • String
  • ffwef
  • respFieldName
  • └ target_field_name
  • String
  • chapterBookId
  • targetFieldName
  • └ rule_id
  • Number
  • demo
  • ruleId
  • └ field_id
  • Number
  • 110
  • fieldId
  • └ file_router
  • String
  • 1
  • fileRouter
  • └ resp_field_name
  • String
  • ffwef
  • respFieldName
  • └ target_field_name
  • String
  • chapterBookId
  • targetFieldName
  • └ rule_id
  • Number
  • demo
  • ruleId
  • └ field_id
  • Number
  • 110
  • fieldId
  • └ file_router
  • String
  • 1
  • fileRouter
  • └ resp_field_name
  • String
  • ffwef
  • respFieldName
  • └ target_field_name
  • String
  • chapterBookId
  • targetFieldName
  • └ rule_id
  • Number
  • demo
  • ruleId
  • └ field_id
  • Number
  • 110
  • fieldId
  • └ file_router
  • String
  • 1
  • fileRouter
  • └ resp_field_name
  • String
  • ffwef
  • respFieldName
  • └ target_field_name
  • String
  • chapterBookId
  • targetFieldName
  • └ rule_id
  • Number
  • demo
  • ruleId
  • └ field_id
  • Number
  • 110
  • fieldId
  • └ file_router
  • String
  • 1
  • fileRouter
  • xml_resp_templates
  • XmlRespTemplate []
  • demo
  • xmlRespTemplate
  • └ level
  • Number
  • 1
  • level
  • sub_templates
  • XmlRespTemplate []
  • 1
  • subTemplates
  • └ child_tag_name
  • String
  • 1
  • childTagName
  • └ child_property_name
  • String
  • 1
  • childPropertyName
  • └ child_property_is_cre
  • Number
  • 1
  • childPropertyIsCre
  • └ child_fields
  • String []
  • 1
  • childFields
  • └ child_property_val
  • String
  • 1
  • childPropertyVal
  • └ self_property_name
  • String
  • 1
  • selfPropertyName
  • └ self_property_val
  • String
  • 1
  • selfPropertyVal
  • sub_templates
  • XmlRespTemplate []
  • 1
  • subTemplates
  • └ child_tag_name
  • String
  • 1
  • childTagName
  • └ child_property_name
  • String
  • 1
  • childPropertyName
  • └ child_property_is_cre
  • Number
  • 1
  • childPropertyIsCre
  • └ child_property_val
  • String
  • 1
  • childPropertyVal
  • └ child_fields
  • String []
  • 1
  • childFields
  • └ self_property_name
  • String
  • 1
  • selfPropertyName
  • └ self_property_val
  • String
  • 1
  • selfPropertyVal
  • └ self_property_is_cre
  • Number
  • 1
  • selfPropertyIsCre
  • └ field_type
  • Number
  • 1
  • fieldType
  • └ sub_templates
  • String []
  • 1
  • subTemplates
  • └ level
  • Number
  • 1
  • level
  • └ field_name
  • String
  • 1
  • fieldName
  • └ level
  • Number
  • 1
  • level
  • └ self_property_is_cre
  • Number
  • 1
  • selfPropertyIsCre
  • └ field_type
  • Number
  • 1
  • fieldType
  • └ field_name
  • String
  • 1
  • fieldName
  • └ self_property_is_cre
  • Number
  • 1
  • selfPropertyIsCre
  • └ self_property_val
  • String
  • 1
  • selfPropertyVal
  • └ self_property_name
  • String
  • 1
  • selfPropertyName
  • └ child_fields
  • String []
  • 1
  • childFields
  • └ child_property_val
  • String
  • 1
  • childPropertyVal
  • └ child_property_is_cre
  • Number
  • 1
  • childPropertyIsCre
  • └ child_property_name
  • String
  • 1
  • childPropertyName
  • └ child_tag_name
  • String
  • 1
  • childTagName
  • └ field_name
  • String
  • 1
  • fieldName
  • └ field_type
  • Number
  • 1
  • fieldType
  • └ online_id
  • Number
  • 216
  • onlineId
  • └ uri_name
  • String
  • /grgiw/fweg
  • uriName
  • └ id
  • Number
  • 388
  • id
  • └ category
  • Number
  • 2
  • category
  • └ channel_id
  • Number
  • 10944
  • channelId
  • └ req_content_type
  • Number
  • 1
  • reqContentType
  • └ sync_type
  • Number
  • 1
  • syncType
  • req_header_templates
  • ReqHeaderTemplate []
  • 1
  • reqHeaderTemplate
  • └ req_field_type
  • Number
  • 1
  • reqFieldType
  • └ default_value
  • String
  • 1
  • defaultValue
  • └ req_field_name
  • String
  • 1
  • reqFieldName
  • req_url_templates
  • ReqTemplate []
  • 1
  • reqUrlTemplate
  • └ check_condition_key_fields
  • String []
  • 1
  • checkConditionKeyField
  • └ target_field_type
  • Number
  • 1
  • targetFieldType
  • └ default_value
  • String
  • 1
  • defaultValue
  • └ check_condition
  • String
  • 1
  • checkCondition
  • └ covert_rule_key_fields
  • String []
  • 1
  • covertRuleKeyField
  • └ req_field_type
  • Number
  • 1
  • reqFieldType
  • └ check_condition_json
  • String
  • 1
  • checkConditionJson
  • └ convert_rule_json
  • String
  • 1
  • convertRuleJson
  • └ convert_rule
  • String
  • 1
  • convertRule
  • └ target_field_name
  • String
  • chapterOrd
  • targetFieldName
  • └ rule_id
  • Number
  • demo
  • ruleId
  • └ req_field_must
  • Number
  • 1
  • reqFieldMust
  • └ req_field_name
  • String
  • cdsv
  • reqFieldName
  • └ field_id
  • Number
  • 111
  • fieldId
  • └ state
  • Number
  • 200
  • state
  • └ message
  • String
  • ok
  • message

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalCopyrightCpapiGetcpapilistRequest req = new AlibabaShuqiOriginalCopyrightCpapiGetcpapilistRequest();
req.setVersionId(1L);
req.setOnlineId(1L);
req.setId(1L);
req.setUri("1");
req.setChannelId(1L);
req.setDisposeId(1L);
AlibabaShuqiOriginalCopyrightCpapiGetcpapilistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_shuqi_original_copyright_cpapi_getcpapilist_response>
    <result>
        <data>
            <ognv_cp_interface_list>
                <ognv_cp_interface_dto>
                    <resp_type>1</resp_type>
                    <cr_time>1626427609</cr_time>
                    <enable_state>1</enable_state>
                    <req_templates>
                        <req_template>
                            <check_condition_key_fields>
                                <string>1</string>
                            </check_condition_key_fields>
                            <target_field_type>1</target_field_type>
                            <default_value>1</default_value>
                            <check_condition>1</check_condition>
                            <covert_rule_key_fields>
                                <string>1</string>
                            </covert_rule_key_fields>
                            <req_field_type>1</req_field_type>
                            <check_condition_json>1</check_condition_json>
                            <convert_rule_json>1</convert_rule_json>
                            <convert_rule>1</convert_rule>
                            <target_field_name>chapterOrd</target_field_name>
                            <rule_id>demo</rule_id>
                            <req_field_must>1</req_field_must>
                            <req_field_name>cdsv</req_field_name>
                            <field_id>111</field_id>
                        </req_template>
                    </req_templates>
                    <req_method>2</req_method>
                    <description>demo</description>
                    <pub_state>1</pub_state>
                    <uri>/grgiw/fweg</uri>
                    <up_time>1626427619</up_time>
                    <resp_templates>
                        <resp_template>
                            <level>1</level>
                            <target_field_type>1</target_field_type>
                            <default_value>22</default_value>
                            <covert_rule_key_fields>
                                <string>1</string>
                            </covert_rule_key_fields>
                            <convert_rule_json>1</convert_rule_json>
                            <resp_field_type>0</resp_field_type>
                            <convert_rule>1</convert_rule>
                            <sub_template_keys>
                                <string>1</string>
                            </sub_template_keys>
                            <sub_templates>
                                <resp_templateg>
                                    <level>1</level>
                                    <target_field_type>1</target_field_type>
                                    <default_value>22</default_value>
                                    <covert_rule_key_fields>
                                        <string>1</string>
                                    </covert_rule_key_fields>
                                    <convert_rule_json>1</convert_rule_json>
                                    <resp_field_type>0</resp_field_type>
                                    <convert_rule>1</convert_rule>
                                    <sub_template_keys>
                                        <string>1</string>
                                    </sub_template_keys>
                                    <sub_templates>
                                        <resp_templateg>
                                            <level>1</level>
                                            <target_field_type>1</target_field_type>
                                            <default_value>22</default_value>
                                            <covert_rule_key_fields>
                                                <string>1</string>
                                            </covert_rule_key_fields>
                                            <convert_rule_json>1</convert_rule_json>
                                            <resp_field_type>0</resp_field_type>
                                            <convert_rule>1</convert_rule>
                                            <sub_template_keys>
                                                <string>1</string>
                                            </sub_template_keys>
                                            <sub_templates>
                                                <resp_templateg>
                                                    <level>1</level>
                                                    <target_field_type>1</target_field_type>
                                                    <default_value>22</default_value>
                                                    <covert_rule_key_fields>
                                                        <string>1</string>
                                                    </covert_rule_key_fields>
                                                    <convert_rule_json>1</convert_rule_json>
                                                    <resp_field_type>0</resp_field_type>
                                                    <convert_rule>1</convert_rule>
                                                    <sub_template_keys>
                                                        <string>1</string>
                                                    </sub_template_keys>
                                                    <sub_templates>
                                                        <string>1</string>
                                                    </sub_templates>
                                                    <resp_field_name>ffwef</resp_field_name>
                                                    <target_field_name>chapterBookId</target_field_name>
                                                    <rule_id>demo</rule_id>
                                                    <field_id>110</field_id>
                                                    <file_router>1</file_router>
                                                </resp_templateg>
                                            </sub_templates>
                                            <resp_field_name>ffwef</resp_field_name>
                                            <target_field_name>chapterBookId</target_field_name>
                                            <rule_id>demo</rule_id>
                                            <field_id>110</field_id>
                                            <file_router>1</file_router>
                                        </resp_templateg>
                                    </sub_templates>
                                    <resp_field_name>ffwef</resp_field_name>
                                    <target_field_name>chapterBookId</target_field_name>
                                    <rule_id>demo</rule_id>
                                    <field_id>110</field_id>
                                    <file_router>1</file_router>
                                </resp_templateg>
                            </sub_templates>
                            <resp_field_name>ffwef</resp_field_name>
                            <target_field_name>chapterBookId</target_field_name>
                            <rule_id>demo</rule_id>
                            <field_id>110</field_id>
                            <file_router>1</file_router>
                        </resp_template>
                    </resp_templates>
                    <xml_resp_templates>
                        <xml_resp_template>
                            <level>1</level>
                            <sub_templates>
                                <xml_resp_template>
                                    <child_tag_name>1</child_tag_name>
                                    <child_property_name>1</child_property_name>
                                    <child_property_is_cre>1</child_property_is_cre>
                                    <child_fields>
                                        <string>1</string>
                                    </child_fields>
                                    <child_property_val>1</child_property_val>
                                    <self_property_name>1</self_property_name>
                                    <self_property_val>1</self_property_val>
                                    <sub_templates>
                                        <xml_resp_template>
                                            <child_tag_name>1</child_tag_name>
                                            <child_property_name>1</child_property_name>
                                            <child_property_is_cre>1</child_property_is_cre>
                                            <child_property_val>1</child_property_val>
                                            <child_fields>
                                                <string>1</string>
                                            </child_fields>
                                            <self_property_name>1</self_property_name>
                                            <self_property_val>1</self_property_val>
                                            <self_property_is_cre>1</self_property_is_cre>
                                            <field_type>1</field_type>
                                            <sub_templates>
                                                <string>1</string>
                                            </sub_templates>
                                            <level>1</level>
                                            <field_name>1</field_name>
                                        </xml_resp_template>
                                    </sub_templates>
                                    <level>1</level>
                                    <self_property_is_cre>1</self_property_is_cre>
                                    <field_type>1</field_type>
                                    <field_name>1</field_name>
                                </xml_resp_template>
                            </sub_templates>
                            <self_property_is_cre>1</self_property_is_cre>
                            <self_property_val>1</self_property_val>
                            <self_property_name>1</self_property_name>
                            <child_fields>
                                <string>1</string>
                            </child_fields>
                            <child_property_val>1</child_property_val>
                            <child_property_is_cre>1</child_property_is_cre>
                            <child_property_name>1</child_property_name>
                            <child_tag_name>1</child_tag_name>
                            <field_name>1</field_name>
                            <field_type>1</field_type>
                        </xml_resp_template>
                    </xml_resp_templates>
                    <online_id>216</online_id>
                    <uri_name>/grgiw/fweg</uri_name>
                    <id>388</id>
                    <category>2</category>
                    <channel_id>10944</channel_id>
                    <req_content_type>1</req_content_type>
                    <sync_type>1</sync_type>
                    <req_header_templates>
                        <req_header_template>
                            <req_field_type>1</req_field_type>
                            <default_value>1</default_value>
                            <req_field_name>1</req_field_name>
                        </req_header_template>
                    </req_header_templates>
                    <req_url_templates>
                        <req_template>
                            <check_condition_key_fields>
                                <string>1</string>
                            </check_condition_key_fields>
                            <target_field_type>1</target_field_type>
                            <default_value>1</default_value>
                            <check_condition>1</check_condition>
                            <covert_rule_key_fields>
                                <string>1</string>
                            </covert_rule_key_fields>
                            <req_field_type>1</req_field_type>
                            <check_condition_json>1</check_condition_json>
                            <convert_rule_json>1</convert_rule_json>
                            <convert_rule>1</convert_rule>
                            <target_field_name>chapterOrd</target_field_name>
                            <rule_id>demo</rule_id>
                            <req_field_must>1</req_field_must>
                            <req_field_name>cdsv</req_field_name>
                            <field_id>111</field_id>
                        </req_template>
                    </req_url_templates>
                </ognv_cp_interface_dto>
            </ognv_cp_interface_list>
        </data>
        <state>200</state>
        <message>ok</message>
    </result>
</alibaba_shuqi_original_copyright_cpapi_getcpapilist_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部